首页 > 其他分享 >代码整洁之道笔记1

代码整洁之道笔记1

时间:2023-11-06 19:44:06浏览次数:32  
标签:语境 代码 笔记 之道 避免 名称 命名 整洁

一.整洁代码
整洁代码的一些特征

代码逻辑应该直接了当,叫缺陷难以隐藏;

尽量减少依赖关系,使之便于维护;

依据某种分层战略完善错误处理代码;

性能调至最优,省得引诱别人做没规矩的优化,搞出一堆混乱来;

整洁的代码只做好一件事;

有单元测试和验收测试;

有意义的命名;

尽量“少”;

两条重要原则:

尽量让代码易读,开发时减少读的时间。

童子军军规:“让营地比你来时更干净”。

二.有意义的命名
名副其实

避免误导

1.程序员必须避免留下掩藏代码本意的错误线索,应当避免使用与本意相悖的词

2.以同样的方式拼写出同样的概念才是信息,拼写前后不一致就是误导

3.要注意使用小写字母i和大写字母O作为变量名,看起来像“壹”和“零”

做有意义的区分

1.不同东西意义不一样时,一定要在命名上区分,如变量,不要简单的cat1,cat2这样区分

命名读得出来,单词可搜索

避免使用编码

1.不要乱用前缀

避免思维映射

1.明确是王道,不要让人需要想象或者产生联想

类名是名词或名词短语,方法名是动词或者动词短语

别扮可爱

别用双关语

1.避免将同一单词用于不同目的

2.应尽力写出易于理解的代码,把代码写得让别人能一目尽览而不必殚精竭虑地研究

使用解决方案领域名称,使用源自所涉问题领域的名称

添加有意义的语境

1.你需要用有良好命名的类、函数或名称空间来放置名称,给读者提供语境

2.如果没这么做,给名称添加前缀就是最后一招了

不要添加没用的语境

1.只要短名称足够清楚,就要比长名称好

最后的话

1.取好名字最难的地方在于需要良好的描述技巧和共有文化背景

标签:语境,代码,笔记,之道,避免,名称,命名,整洁
From: https://www.cnblogs.com/liucaizhi/p/17813551.html

相关文章

  • 笔记本共享WIFI到本地网口,网口供 linux 机器提供网络
    1.WLAN属性,设置为共享 2.查询Windows笔记本IP地址 3.  ......
  • JUC并发编程学习笔记(十四)异步回调
    异步回调Future设计的初衷:对将来的某个事件的结果进行建模在Future类的子类中可以找到CompletableFuture,在介绍中可以看到这是为非异步的请求使用一些异步的方法来处理点进具体实现类中,查看方法,可以看到CompletableFuture中的异步内部类,里面是实现的异步方法以及一些异步......
  • [机器学习复习笔记] Linear Regression 线性回归(最小二乘法求解析解)
    LinearRegression1.一元线性回归定义一个一次函数如下:\[y=\theta_0+\theta_1x\]其中\(\theta\)被称为函数的参数。显然在坐标图上,这个函数的图像是一条直线,这也是线性回归中的线性含义所在。只有一个\(x\)来预测\(y\),就是用一条直线来拟合数据,即一元线......
  • 读书笔记——《软件需求模式》其一
    《软件需求模式》是StephenWithall撰写的一本重要著作,旨在探讨和提供关于软件需求工程的模式和技术。本书深入剖析了软件需求工程的各个方面,并通过引入一系列软件需求模式,为软件开发人员提供了解决常见问题和挑战的实用解决方案。作者首先强调了需求工程的重要性,指出清晰、准确......
  • 《python基础教程(第二版)》学习笔记 文件和素材(第11章)
    《python基础教程(第二版)》学习笔记文件和素材(第11章)打开文件:open(filename[,mode[,buffering]])mode是读写文件的模式f=open(r'c:\somefile.txt')#默认是读模式+表示是可以读写;r读模式;w写模式;a追加模式;b二进制模式;换行符在Windows为\r\n,在Unix中为\n,Python会自动转......
  • 《python基础教程(第二版)》学习笔记 函数(第6章)
    《python基础教程(第二版)》学习笔记函数(第6章)创建函数:deffunction_name(params):blockreturnvalues记录函数:deffunction_name(params):'NOTE'#注释blockreturnvaluesfunction_name.__doc__help(function_name)return#没有返回值位置参数和关键字参数:关......
  • 《python基础教程(第二版)》学习笔记 类和对象(第7章)
    《python基础教程(第二版)》学习笔记类和对象(第7章)定义类classPerson:defsetName(self,name):self.name=namedefgetName(self):returnself.namefoo=Person()foo.setName('AAA')foo.getName()foo.namefoo.name='BBB'私有属性,名字前面加上......
  • hrml-js笔记
    Chrome警告:PagelayoutmaybeunexpectedduetoQuirksMode文档加上<!DOCTYPEhtml>修改后一个悬浮的Div位置错误TipDiv.style.left=event.clientX;...修改后为 TipDiv.style.left=''+event.clientX+'px'; TipDiv.style.top=''......
  • 9月份 《程序员修炼之道——从小工到专家》读后感2
    第二章注重实效的途径1重复的危害系统中的每一项知识都必须是单一、无歧义、权威的表示;DRY-Dontrepeatyourself不要重复你自己;重复如何发生    强加的重复        信息的多种表示        代码中的文档;把注释保留给其他的高级说明 ......
  • 9月份 《程序员修炼之道——从小工到专家》读后感1
    第一章注重实效的哲学1我的源码让猫给吃了在所有的弱点中,最大的弱点就是害怕暴露弱点;同意为某个结果负责,就应切实负起责任;不要抱怨,总是把问题归咎于别人;辩解听起来很愚蠢,说话之前先将借口清除,谈话之前自己先预演一遍;提供选择,而不是找借口,不要说做不到,而是能够做什么挽回局面;2软......