15个编程好习惯(转)

【转载的文章加了一点自己的注释】

http://www.cnbeta.com/articles/138055.htm

编者按：这是国外程序员Al katib总结的一些编程习惯。
1. 动手编码之前，你需要对要编码实现的解决方案有一个正式的或粗略的设计。永远不要在没有任何设计的前提下就开始编码，除非所编代码不重要。

【这一点刚开始编程的时候总是不以为然，但随着代码的积累，才渐渐明白设计的重要性。这设计可能不是面面俱到，确实很重要】

 

2. 优秀的代码文档跟编程语言知识一样重要。在代码源文件中，为每个主要的代码段添加注释，解释代码的基本逻辑。最好注明程序的构建和修改日期，以及修改的原因也是非常有必要的。【注释中不能有废话】

3. 维护程序的各个版本同样重要。当前有些编程工具都自带一个版本管理工具。无论你什么时候改变自己的程序，它们都会将其保存为.bak文件。【用svn就好了】

　　我的方法是为每个程序维护三个不同的版本。比如说，我有一个名为program.c的文件，这个文件同时也被其他项目组成员使用。我把这个文件复制为 program.c.old作为备份文件，并且当我修改时，我会备份另一个名为program.c.wrk的副本文件。当成功完成修改时替换 program.c.wrk文件。

　　你还可以给自己的程序版本添加一个日期或一些注释，像program260505.c或programReadFnWrking.c。

4. 如果工程包含多个源文件，则声称一个README文件，注明每个源文件、数据文件、临时文件以及日志文件(如果有的话)的作用。你还可以注明编译和运行步骤。【这一点本人觉得没有必要，只要代码文件名称恰当就好了】

5. 有时候，你一定想知道为什么IF语句没有得到预想的结果。可能你使用的是等号，也就是“=”，而不是条件判定符号“==”。一个比较好的办法是用相反的顺序写条件语句。因此，你的条件语句应该如下：

　　if(10==i)…因此，如果你错误地写成了单个等于号，在编译的时候也能检查出来并报错。

6.使用循环和条件语句时，先把左右括号对应起来，然后再在里面写其他语句。也就是：

代码: 1 for(int i=0;i<10;i++)2 {4 printf(“i=%dn”,i);3 } 　　注：每一行开头的数字表明写循环代码的顺序。

7. 避免使用幻数（magic numbers）。例如，不要写

代码: circleArea = 3.14 * pow(radius,2); 而要使用如下代码：

代码: #define PI 3.14 circleArea = PI * pow(radius,2);

【有些地方说用枚举变量和常量代替】
8. 使用有意义的变量和函数名称。例如，使用‘radius’来代替圆的半径，而不是用‘r’来表示。同样，函数名‘calculateArea’要比其他任何隐晦的缩写要好得多。匆忙之下，我们也许会使用缩写的变量名，但一开始节省时间的话，之后会浪费更多的时间，去猜测缩写变量名代表什么。（编注：）

9. 为后面的调试使用打印语句，这是个好习惯。但是，当完成最后代码后，去掉这些语句，有时也是一项危险的任务。添加一个方法，用于输出调试信息。当最终版本生成时，只要把这个方法注释掉就行。因此，只在一个地方做修改就可以了。

【这的确是个好习惯，对调试很有利】

10. 代码编写完之后，开始优化代码。之前声明的一些变量，现在可能没用了。同样，并不依赖循环的一些声明可以移到循环模块之外去。扎实的编译知识同样会对以后的代码优化有所帮助。

【这一点以后得注意，现在好写还没有养成优化代码的习惯】

11. 对自己的操作系统和硬件要有足够的了解，你可以从资源占用等方面提升程序的性能。

12. 编写代码时要合理使用缩进，以使代码清晰可读。【这一点可以略去，编译器通常会帮你做】

13. 把项目文件放到SOURCE、HEADERS、MAKE、EXES等不同的文件夹中。

14. 研究别人编写的代码。这可以让你学习到新的编程技术，以及他们解决和你相同的任务时所使用的方法。

【这是程序猿必经之路】

15. 最后一条（但不是最不重要的一条)，备份源代码文件，这样当硬盘出错或相同的问题发生时，不至于前功尽弃。

【如果用SVN的话，就不必记住这一条了】

附加：补充一条，坚持使用一种命名模式。如果你打算用匈牙利命名法，那就坚持并广泛使用，否则将适得其反。参见微软资深工程师 Eric Lippert 的这篇文章《阅读代码不简单》。

【个人觉得匈牙利命名法还是很好的，至少不习惯java的命名习惯】

　　编者后话

　　编程的好习惯应不止这15条，也许您不认同上文中的某些观点，请标出相应序号，并说明其不足之处。另外，非常欢迎大家补充分享您的好习惯。

　　译文出处：伯乐在线 - 职场博客
　　译文链接：http://www.jobbole.com/entry.php/581