整洁代码学习

编程语言

1.避免误导

不在变量名后增加非该类型的后缀名
例如accountList 在后面添加的List而该变量并不是list类

2.做有意义的区分

两个不一样的变量需要不一样的命名意义、

3.使用读的出来的名称

1. 在使用某些参数的时候，先通过给数值进行变量赋值，描述其意义后在进行运算。
2. 不要造出难以读出来的变量名。

4.避免变量名称的编码

1.不需要使用匈牙利标记法
2.忽略变量的类型前缀

5.类名

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

6.方法名

方法名因当时动词或动词短语。

7.使用专业领域的名称

可以使用计算机领域的专业名词以及原子所设计问题领域的名称。

8.为变量添加语境

通过添加前缀来使得变量具有语境意义
例如：state bookState,computerState
通过类来将函数分解为更小的函数。

9.不要添加没用的语境

只要短名称足够清楚，就要比长名称好。别给名称添加不必要的语境。

10.短小

函数的第一规则是要短小。第二条规则是还要更短小
if语句、else语句、while语句中的代码英爱只有一行，大抵应该是一个函数调用语句。

11.只做一件事

函数应该做一件事。做好这件事。只做一件事。
别害怕长名称。长而具有描述性的名称，要比短而令人费解的名称好。长而具有描述性的名称，要比描述性的长注释好。

12.使用描述性的名称

别害怕长名称。长而具有描述性的名称，要比短而令人费解的名称好。

13.函数参数

函数的参数尽量设置的少，输出参数更加的令人费解

14.抽离try/catch代码块

最好把try/catch代码块的主题部分抽离出来，另外形成函数。

15.消灭重复

一切设计都是为了消灭重复

16.如何写出这样的函数

一开始的代码总是杂乱无章的，因此需要再次的打磨，分解函数，修改名称，消除重复。

注释

陈旧的注释会给代码带来毁灭性的东西。

可注释的内容

1. 法律信息
2. 抽象方法的返回值
3. 对意图的注释
4. 阐释难懂的参数
5. 警示
6. TODO注释
   循规式注释：

//函数的注释
/**
* The description of the function
*
* @param title The tile of the CD
* @param author The author of the CD
* @param tracks The number of tracks on the CD
* @param durationInMinutes the duration of the CD in minutes
*/

//单个变量的说明注释
/** The iterate.*/
int i;

和变量名一样，要花时间写好的注释

能用函数或变狼时就别用注释

删除掉注释的代码

格式

1. 代码中密切相关的代码片段要放在一起
2. 变量的定义尽可能靠近其使用的位置。
   循环语句的控制变量应该和循环语句一起
3. 实体变量应该在类的顶部声明
4. 应该尽力保持代码行短小
5. 使用空格将相关性较弱的事物分隔开。
6. 不需要特意的水平对齐
7. 缩进的重要性