代码整洁之道笔记(一)
今天读了代码整洁之道这本书,虽然没有读完,但是为了给你自己加深影响,也为了给自己锻炼写博文的能力,同时大家也可以从我的博文中知道整洁之道讲了那些内容,来提高自己的代码质量。
第一章 整洁代码
第一章主要讲了什么是整洁代码,并且引用了几位大家对于什么是整洁的代码的看法:有的认为优雅且高效的代码,代码逻辑直截了当的是整洁代码,也有的人认为如果每个例程都让你感到深合己意就是整洁代码等等。作者在书中怎样看待整洁代码的,那就要我们一起看下去了。
第二章 有意义的命名
从标题我们就可以看出本章主要讲了怎样来命名,什么的命名是有意义的。主要讲了几个简单的命名规则
- 名副其实
顾名思义就是读者看到这个命名就知道是什么意思。
- 避免误导
文中提到尽量不要用accountLst来指一组账号,除非它真是List类型。List一词对于程序员有特殊的意义。如果包含账号的容器不是List就会引起错误的判断。所以用accountCroup或者accounts会好一些。
- 做有意义的区分
需要程序员不要满足编译器或者解释器来编写代码,要区分名称,就要以读者能鉴别不同之处的方式来区分。
- 使用读得出来的名称
读者的意思就是不要自己造一些不好的词,例如generationTimestamp就比genymdhms好。
- 使用可以搜索的名称
使用容易通过搜索找到的名称
- 避免使用编码
不要把类型或作用域编进名称里面
- 避免思维映射
就是不要让读者把你的名字翻译他们熟知的名称而不是你要表达。
- 类名应该是名词或者是名词短语
- 方法名应该是动词或者动词短语
- 名词不要太耍宝,不要扮可爱
- 函数名词应该是独一无二,每一个概念对应一个词
- 别用双观语
- 使用解决方案领域名词
记住只有程序员才会读你的代码,所以尽量用计算机科学术语。
-
使用源自所涉问题领域的名称
与所涉领域更为贴近的代码,应当采用源自问题领域的名称。 -
添加有意义的语境
- 不要添加无用的语境
原创文章,作者:ItWorker,如若转载,请注明出处:https://blog.ytso.com/13832.html