良好的代码风格

额，由于在简历中增加了一笔，“具有良好的代码风格”，所以，今天早上花时间来整理了一下。主要参考了《java编程风格》和陈皓的《编程修养》这篇文档。

良好的编程风格

1.一般原则

2.格式规范

3.命名约定

4.文档约定

5.编程约定

1. 一般原则

（1）      保持项目原有的风格

（2）      坚持最小惊奇原则

（3）      简单性、清晰性、完整性、一致性、健壮性

简单性：没有一句废话，项目代码量越少，bug机会越小

清晰性：确保每个类、接口、方法和对象都有明确的用途，弄清楚何时、何地、为何使用

完整性：编写完整的说明文档

一致性：相似的实体，其外观和行为要一致（差不多是最小惊奇原则的一个体现）

健壮性：为错误和异常做出预测，并在程序中处理。假设用户都是蛮不讲理的用户（effective c++的教诲）

 

格式规范：

1.      缩进嵌套代码（if,else;switch,类、方法、内部类定义，try-catch块），注意不要使用tab键来控制缩进，因为协作的程序员之间的编辑器对这个解释不同。

2.      断开长句，如果传入参数太长，也得分行

 

命名约定：

1.      名称应该有实际意义，绝对不要使用幻数（比如65这样的数字，谁知道这有什么意义。用final int UPPER = 65，我们就知道了，65的意思是上限，然后将项目中的65统统替换成UPPER。）

2.      包命名（倒置命名，如公司名为www.zju.edu.cn，那么报名就是cn.edu.zju.www）

3.      类和接口命名：a.要有意义(毕竟编程是计算机世界对人类世界的反应，如果项目中出现一大推a,b,c这样的类名，谁看到不火？)b.每个单词的第一个字母大写

4.      方法命名：a.方法命名要体现做了什么，要人一看就明白。B第一个单词小写，以后每个单词的第一个大写字母大写。

5.      变量命名与方法一样。集合类使用复数，加个s就行了。

6.      常量命名：每个单词都大写，单词之间使用下划线。

 

文档约定：

在类和接口的描述中：

/**

*描述

*

*@author

*@version

*@see

*@since

*@deprecated

*/

 

方法的描述

/**

*

*@param

*@return

*@exception

*

*/

 

当然，还需要一些良好的编程修养。参见陈皓《编程修养》一文。这篇文章跟多的谈的是C语言中的一些事情。