软件编程规范(节选)
常用的软件编程规范中条例,平时有些能注意的注意下。良好的编码习惯会让以后的工作更简单。
¹2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
¹2-5:边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。
¹2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
¹2-12:注释与所描述内容进行同样的缩排。
¹2-13:将注释与其上面的代码用空行隔开。
¹2-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。
¹3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。
¹3-2:命名中若使用特殊约定或缩写,则要有注释说明。
¹3-3:自己特有的命名风格,要自始至终保持一致,不可来回变化。
¹3-4:对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。
¹8-1:编程时要经常注意代码的效率。
¹8-2:在保证软件系统的正确性、稳定性、可读性及可测性的前提下,提高代码效率。
¹8-3:局部效率应为全局效率服务,不能因为提高局部效率而对全局效率造成影响。
¹8-4:通过对系统数据结构的划分与组织的改进,以及对程序算法的优化来提高空间效率。
¹8-5:循环体内工作量最小化。
9-12:不能随意改变与其它模块的接口。
9-16:有可能的话,if语句尽量加上else分支,对没有else分支的语句要小心对待;switch语句必须有default分支。
作者:panie
出处:http://www.cnblogs.com/panie2015/
如果您希望与我交流互动,欢迎加我微信
本文内容为作者辛苦整理书写,欢迎转载,但请保留文章出处