15个编程好习惯

11顶
10踩

2011-03-23 16:48 by 见习编辑 jobbole 评论(18) 有16549人浏览

编程

声明：ITeye资讯文章的版权属于ITeye网站所有，严禁任何网站转载本文，否则必将追究法律责任！

　　编者按：这是国外程序员Al katib总结的一些编程习惯。

　　1. 动手编码之前，你需要对要编码实现的解决方案有一个正式的或粗略的设计。永远不要在没有任何设计的前提下就开始编码，除非所编代码不重要。

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

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

　　我的方法是为每个程序维护三个不同的版本。比如说，我有一个名为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. 最后一条（但不是最不重要的一条)，备份源代码文件，这样当硬盘出错或相同的问题发生时，不至于前功尽弃。

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

　　编者后话

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

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

　　原文作者：Al katib　　　文章推荐：关关　　翻译：伯乐在线敏捷翻译组 - 朱勇

来自: www.jobbole.com

分享到：

11
顶

10
踩

评论共 18 条请登录后发表评论

18 楼 monica617 2011-03-25 10:54

个人同意多看别人的代码，尤其是优质的代码能提高自己的编码水平

17 楼 liuzhiqiangruc 2011-03-25 09:29

针对某个功能，先把框架搭出来，每个分支可以只打印一个简单的语句，表明程序能够很好地覆盖所需要覆盖的逻辑，然后再每个分支中编写对应的逻辑，最后在各分支中用到的共用的变量等信息提取到程序的开始或结尾，保持程序的整洁。

16 楼 Puras 2011-03-25 09:02

风花雪月饼写道

这玩意也上新闻了？

JE上向来如此，哈。

15 楼 jianson_wu 2011-03-25 08:44

嗯嗯，值得学习

14 楼 shengt1 2011-03-24 16:41

学会总结归纳

13 楼 hantsy 2011-03-24 16:04

第一点重要，
程序员就是用程序来表达自己的思想，如果事先不经过思考出来的程序，可想而知。

12 楼风花雪月饼 2011-03-24 15:29

这玩意也上新闻了？

11 楼 yizhilong28 2011-03-24 12:44

damoqiongqiu 写道

陈词滥调，

听得太多，麻木了。。

10 楼 damoqiongqiu 2011-03-24 12:21

陈词滥调，

9 楼 Ring风 2011-03-24 11:10

请参阅《代码大全2》《code complete2》，里面详细论述了多种编程原则与技巧，能提高代码质量。

8 楼 aiyanbo 2011-03-24 09:38

我在想，写这篇文章的大哥是不是用记事本写代码的？

7 楼 geminiyellow 2011-03-24 09:33

beeke 写道

这位国外程序员是新手吧

no，做外包的新手笔记。

6 楼 zhanghe086 2011-03-24 09:32

借鉴借鉴，以后用的着

5 楼 beeke 2011-03-24 09:26

这位国外程序员是新手吧

4 楼 LubinJava 2011-03-24 08:37

借鉴之..

3 楼 xiaodatao 2011-03-24 08:08

7. 避免使用幻数（magic numbers）

2 楼 huyang1205 2011-03-24 00:59

是的，借鉴学习

1 楼 lixinyang 2011-03-23 22:42

3/15两条：作者不用SCM工具吗？git、svn、cvs都好呀
6/12/13三条：Eclipse这类的IDE会帮你搞定这些基本东西的。
其他的多数条目都是非常有帮助的

发表评论

您还没有登录,请您登录后再发表评论

11顶10踩