代码规范简介
程序编写规范简介
在软件编程过程中,如果每个程序员都按自己的习惯和风格编写程序,这种因人而异的程序风格势必降低程序的可读性,对软件的测试、交流、重用以及软件的维护产生极为不利的影响。为了解决这个问题,最终提高开发效率,必须执行本规范。
本规范在编程基本风格、可读性、结构化、正确性与容错性、可重用性等方面提出了如下要求:
1.基本要求
1.1程序结构清析,简单易懂,单个函数的程序行数不得超过100行。
1.2打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
1.3尽量使用标准库函数和公共函数。
1.4不要随意定义全局变量,尽量使用局部变量。
1.5使用括号以避免二义性。
2.可读性要求
2.1可读性第一,效率第二。
2.2保持注释与代码完全一致。
2.3每个源程序文件,都有文件头说明,说明规格见规范。
2.4每个函数,都有函数头说明,说明规格见规范。
2.5主要变量(结构、联合、类或对象)定义或引用时,注释能反映其含义。
2.6一个类的接口不要多于200个。(是不是太多了)
2.7常量定义(DEFINE)有相应说明。
2.8处理过程的每个阶段都有相关注释说明。
2.9在典型算法前都有注释。
2.10利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为 4个字节。
2.11循环、分支层次不要超过五层。
2.12注释可以与语句在同一行,也可以在上行。
2.13空行和空白字符也是一种特殊注释。
2.14一目了然的语句不加注释。
2.15注释的作用范围可以为:定义、引用、条件分支以及一段代码。
2.16注释行数(不包括程序头和函数头说明部分)应占总行数的 1/5 到 1/3 。
3.结构化要求
3.1禁止出现两条等价的支路。
3.2禁止GOTO语句。
3.3用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。
3.4用 CASE 实现多路分支。
3.5避免从循环引出多个出口。
3.6函数只有一个出口。
3.7不使用条件赋值语句。
3.8避免不必要的分支。
3.9不要轻易用条件分支去替换逻辑表达式。
4.正确性与容错性要求
4.1程序首先是正确,其次是优美<br> 4.2无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。
4.3改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。
4.4所有变量在调用前必须被初始化。
4.5对所有的用户输入,必须进行合法性检查。
4.6不要比较浮点数的相等,
如: 10.0 * 0.1 == 1.0 , 不可靠
4.7程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等。
4.8单元测试也是编程的一部分,提交联调测试的程序必须通过单元测试。
5.可重用性要求
5.1重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
5.2公共控件或类应考虑OO思想,减少外界联系,考虑独立性或封装性。
5.3公共控件或类应建立使用模板。
5.4建议尽可能的使用STL来做为一般的数据处理方法。
6.命名规则
6.1全局变量、属性与接口函数的名称用英文(首字母大写)的组合完成,如ConsumeStr,GetConsumeStr()等。
6.2私有与保护的成员命名时,前边多加一个大写字母F做为标志,如:FConsumeStr。
6.3函数的形式参数名命名时,前边多加一个大写字母A做为标志,如:AIndex。
6.4对于临时的局部变量用temp*,或tmp*,不过对于有着固定意义的变量,可以用首字母小写+首字母大写的单词来组合。
如:next、nextPtr等。
6.5尽可能的使用英文单词来命名,如果用英文不好表达可以用简单拼音加英文来表示。
如:DeName //表示定额名称。
7.封装性的问题
7.1对于数据成员一般不要公开,声明为保护与私有的,如需要公开则可能用属性来完成,但此时相应的内部数据就需要至于声明为保护的。
7.2对于属性内部的数据的读取是禁止的,如果通过属性的读取函数会有副作用时,可能通过增加接口函数来完成。
7.3所有的类的析构函数都应是虚函数。
7.4对于友元最好不用,操作符重载应谨慎使用。
7.5多态很重要,但不可以过度的使用虚函数。