15个编程好习惯

Wesley13
• 阅读 672

来源:http://www.ackarlix.com/?p=505

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条,也许您不认同上文中的某些观点,请标出相应序号,并说明其不足之处。另外,非常欢迎大家补充分享您的好习惯。

来源:Ackarlix博客http://www.ackarlix.com/

点赞
收藏
评论区
推荐文章
低代码开发平台 | 低代码的衍生历程、优势及未来趋势
通过简单的拖拉拽操作,而不用编写复杂的代码,实现少写代码或者不写代码,就能快速高效完成业务目标。低代码平台演进1.低代码概念低代码是无需编码(0代码)或通过少量代码就可以快速生成应用程序的开发平台。通过可视化进行应用程序开发的方法,具有不同经验水平的开发人员可以通过图形化的用户界面,使用拖拽组件和模型驱动的逻辑来创建网页和移动应用程序。2.低代码衍生历
梦想橡皮擦 梦想橡皮擦
3年前
5. Python 循环的本质就是一段代码懒得重复写
为啥要滚雪球学Python,目的就是当你学会编程一些思想之后,可以让知识的雪球自行滚动起来。五、Python循环的本质就是一段代码懒得重复写程序中的循环概念非常容易理解,一段相似的代码不想重复去写,然后让程序去完成这个操作就是循环。例如从1加到100,如果你依次去加会发现,代码又臭又长,最好的写法当然是让程序通过循环依次去累加。
Stella981 Stella981
3年前
Google Java 代码规范
1.(1)简介本文档用于Java编程语言的Google源代码编码标准的完整定义。Java源文件定义为Google风格。于其他编程风格指南一样,所涉及的问题不止包含代码格式美化,还包括其他类型的约定或者编码标准。但是本文档主要关注普遍遵循的严格规则,并避免提供意义不明的可执行建议(无论任何方式)。1.1.
Stella981 Stella981
3年前
HTML中meta标签的作用与使用
META标签用来描述一个HTML网页文档的属性META标签可分为两大部分:HTTPEQUIV和NAME变量。HTTP实例HTML代码实例中有一项内容是<metahttpequiv"ContentType"content"text/html;charsetgb2312"其作用是指定了当前文档所使用的字符编码为gb2
Wesley13 Wesley13
3年前
Java代码编写规范(转)
编码规范1前言为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程。系统继承的其它资源中的源程序也应按此规范作相应修改。2适用范围本文档将作为java编程人员软件开发的编程格式规范。在项目Java部分的编码、测试及维护过程中,要求严格遵守
Stella981 Stella981
3年前
Intellij IDEA安装阿里代码规范插件
要养成一个好的编码习惯从自己编码开始,对自己代码的合理化命名,编码不仅对自己有好处,而且别人也容易读懂你的代码。所以下载阿里的代码规范插件来约束自己凌乱的代码。阿里规范插件GitHub地址:https://github.com/alibaba/p3cIDEA安装该插件步骤:1.打开IDEA,FileSetteingsPlug
Wesley13 Wesley13
3年前
C++ 注释
C注释程序的注释是解释性语句,您可以在C代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。C支持单行注释和多行注释。注释中的所有字符会被C编译器忽略。1include<iostream23/runthisprogramusingthe
小万哥 小万哥
1年前
提高代码可读性的8个技巧
编程有很大一部分时间是在阅读代码,不仅要阅读自己的代码,而且要阅读别人的代码。因此,可读性良好的代码能够大大提高编程效率。可读性良好的代码往往会让代码架构更好,因为程序员更愿意去修改这部分代码,而且也更容易修改。只有在核心领域为了效率才可以放弃可读性,否则
京东云开发者 京东云开发者
7个月前
京东云“智能编码”上线了!免费试用
智能编码JoyCoder是一款基于大语言模型、适配多种IDE的智能编程助手,可以为研发人员提供代码预测续写、UI草图转前端代码、生成单元测试、代码安全漏洞自动识别及修复、一键生成接口文档、AI智能问答等功能。助力开发者高效、流畅、智能化地编程!AI辅助编程
敏捷开发 敏捷开发
3个月前
写不好代码注释?这份注释指南一定要收好!
之前有读者问,自己一直不明白如何写出合理的代码注释。这也是不少程序员一直头疼的问题,比如接手新代码时,没有注释,完全搞不清逻辑;自己写的注释,跟不上代码修改,成了误导;复杂逻辑不知道咋注释,别人也看不懂。(听君一席话,听了一席话)网上也有很多关于代码注释的