写代码的好习惯

写代码的好习惯

1. 动手编码之前,你需要对要编码实现的解决方案有一个正式的或粗略的设计。不要在没有任何设计的前提下就开始编码 2. 在代码源文件中,为每个主要的代码段添加注释,解释代码的基本逻辑。最好注明程序的构建和修改日期,以及修改的原因也是非常有必要的。 3. 如果工程包含多个源文件,则声称一个README文件,注明每个源文件、数据文件、临时文件以及日志文件(如果有的话)的作用。你还可以注明编译和运行步骤。

4. 有时候,你一定想知道为什么IF语句没有得到预想的结果。可能你使用的是等号,也就是“=”,而不是条件判定符号“==”。一个比较好的办法是用相反的顺序写条件语句。因此,你的条件语句应该如下:   if(10==i)…因此,如果你错误地写成了单个等于号,在编译的时候也能检查出来并报错。   5.使用循环和条件语句时,先把左右括号对应起来,然后再在里面写其他语句。也就是: 代码: 1 for(int i=0;i<10;i++) 2 { 4 printf(“i=%dn”,i); 3 }   注:每一行开头的数字表明写循环代码的顺序。   6. 避免使用幻数(magic numbers)。例如,不要写 代码: circleArea = 3.14 * pow(radius,2); 而要使用如下代码: 代码: #define PI 3.14 circleArea = PI * pow(radius,2);      7.使用有意义的变量和函数名称。例如,使用‘radius’来代替圆的半径,而不是用‘r’来表示。   8. 为后面的调试使用打印语句,这是个好习惯。但是,当完成最后代码后,去掉这些语句,有时也是一项危险的任务。添加一个方法,用于输出调试信息。当最终版本生成时,只要把这个方法注释掉就行。因此,只在一个地方做修改就可以了。   9. 代码编写完之后,开始优化代码。之前声明的一些变量,现在可能没用了。同样,并不依赖循环的一些声明可以移到循环模块之外去。扎实的编译知识同样会对以后的代码优化有所帮助。   10. 对自己的操作系统和硬件要有足够的了解,你可以从资源占用等方面提升程序的性能。   11. 编写代码时要合理使用缩进,以使代码清晰可读。   12. 把项目文件放到SOURCE、HEADERS、MAKE、EXES等不同的文件夹中。   13. 研究别人编写的代码。这可以让你学习到新的编程技术,以及他们解决和你相同的任务时所使用的方法。   14. 最后一条(但不是最不重要的一条),备份源代码文件,这样当硬盘出错或相同的问题发生时,不至于前功尽弃。   附加:补充一条,坚持使用一种命名模式。如果你打算用匈牙利命名法,那就坚持并广泛使用,否则将适得其反。

匈牙利命名法

匈牙利命名法是一种编程时的命名规范。基本原则是:变量名=属性+类型+对象描述,其中每一对象的名称都要求有明确含义,可以取对象名字全称或名字的一部分。要基于容易记忆容易理解的原则。保证名字的连贯性是非常重要的。
自己写一遍,记得牢!
posted @ 2019-10-27 18:25  小黑97  阅读(270)  评论(0编辑  收藏  举报