《代码整洁之道》读书笔记2

第二章  有意义的命名

1.名副其实。 说起来很简单。选个好名字需要花时间,但省下的时间比花掉的多。注意命名,一旦有好的命名,就换掉旧的。

int d;//消失的时间,以日计。int elapsedTimeInDays,int daysSinceCreation;

我们定义不同的变量,能够看到名字就知道是什么意思,这是最基本的要求了。

2.避免误导。比如不是List类型,就不要用个accountList来命名,这样形成误导。

3.做有意的区分。

Public static void copyChars(char a1[],char a2[]){

for(int i=0;i<a1.length;i++){

a2[i]=a1[i]

}

}

如果参数名称改为source和destination ,这个函数就会像样很多。废话都是冗余的,Variable一词 永远不应当出现在变量名中。Table一词永远不应当出现在表名中。NameString 会比 Name好吗,难道Name 会是一个浮点数不成?如有一个Customer的类,有又一个CustomerObject的类。是不是就凌乱了。

4.使用便于搜索的的名称

单个字母或者数字常量是很难在一大堆文章中找出来。比如字母e,它是英文中最常用的字母。长名胜于短名称,搜得到的名称胜于自编的名称。 窃以为单字母的名称仅用于短方法中的本地变量。名称长短应与其作用域大小相对应。

5.类名应该是名词或短语

像Customer,Account,避免使用Manager,Processor,Data或者Info这样的类名。类名不应当是动词。方法名应该是动词或动词短语,如postPayment ,deletePage或Save,属性访问、修改和断言应该根据其值来命名,并加上get,set,is这些前缀。

6.别扮可爱,耍宝

比如谁知道HolyHandGrenada 函数是干什么的,没错这个名字挺伶俐,但是不过DeleteItems或许是更好的名字。

7.每个概念对应一个词。并且一以贯之。

在一堆代码中有Controller,又有manager,driver。就会令人困惑。比如DeviceManager和Protal-Controller之间又什么本质区别?

第三章 函数

1.函数的第一规则是要短小,第二条规则是还要更短小。

2.函数应该做一件事。做好这件事。只做这一件事。

3.尽量少的函数参数。有两个参数的函数要比一元函数的难懂。如果需要三个或者三个以上的参数应该封装成类了。

4.不要重复自己。

如果一段相同的代码出现了两次,你是不是觉得自己改做些什么了。



链接:https://www.jianshu.com/p/b8f0846e0ea2

 以前自己的做法:对对象命名比较随意,比较喜欢用拼音 知道英文时会用英文  都包和类的命名没有规范比如dao前缀类似的 有时候函数比较麻烦 因为算法用的不够好

改进:多学英文 学习好的命名方法 多学习好的算法 简短函数

 

posted on 2020-10-17 22:54  孔kk  阅读(76)  评论(0)    收藏  举报

导航