《明星软件工程师的10种特质》中提到: 编写优秀代码和糟糕代码所花费的时间是一样多。一位训练有素的工程师,他/她会从第一行代码开始就考虑可维护性和代码的演化。
软件逐渐走向大型化。在这种软件走向大型化得形势下,一个软件需要众多的人参与。比如一个操作系统的开发需要上千人的工作。这样我们就不得不面临着如何管理。
好的代码习惯和注释,能够给予软件维护和管理极大的帮助。虽然在不同环境下优秀的标准不太一样,但是重要的在于代码的意识,软件界有一个的秘密:编写优秀代码和糟糕代码所花费的时间是一样多。具有强烈得意识和责任心,才能写出好代码。
有了意识的同时,也要有很好的代码习惯,才能建立良好的职业操守。在编码时,有些程序员会有这种心态:过一会儿再来修改或完善某部分代码或某条语句。但谁知这一“过一会”竟然是“一天”、“一周”、“一个月”或“一年”,甚至以后根本就没机会再回头修改。所以,尽量别妥协写出暂时堪用(可以使用)的代码。否则,不仅不会节省开发时间,也可以阻碍整个进程。当然也不利于后续维护人员的工作。
代码书写规范:
1. 程序结构清析,简单易懂,单个函数的程序行数不得超过100行。
2. 打算干什么,要简单,直截了当,代码精简,避免垃圾程序。
3. 尽量使用标准库函数和公共函数。
5. 使用括号以避免二义性。
可读性要求:
1、可读性第一,效率第二。
2、保持注释与代码完全一致。
4、每个函数,都有函数头说明,说明规格见规范。
5、主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。
6、常量定义(DEFINE)有相应说明。
7、处理过程的每个阶段都有相关注释说明。
8、在典型算法前都有注释。
9、利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为6个
字节。
10、循环、分支层次不要超过五层。
11、注释可以与语句在同一行,也可以在上行。
12、空行和空白字符也是一种特殊注释。
13、一目了然的语句不加注释。
14、注释的作用范围可以为:定义、引用、条件分支以及一段代码。
15、注释行数(不包括程序头和函数头说明部份)应占总行数的1/2 到 1/3 。