软件编程规范总则checklist

软件编程规范总则checklist

ID:11314692

大小:121.50 KB

页数:7页

时间:2018-07-11

软件编程规范总则checklist_第1页
软件编程规范总则checklist_第2页
软件编程规范总则checklist_第3页
软件编程规范总则checklist_第4页
软件编程规范总则checklist_第5页
资源描述:

《软件编程规范总则checklist》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库

1、软件编程规范总则CHECKLIST检查人:________________检查日期:1999年_____月_____日审查内容:____________________________________________________________________审查结果:通过□不通过□说明:____________________________________________________________________序号总则条款执行情况说明1排版1¹1-1:程序块要采用缩进风格编写,缩进的空格

2、数为4个。是[]否[]免[]2¹1-2:相对独立的程序块之间、变量说明之后必须加空行。是[]否[]免[]3¹1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。是[]否[]免[]4¹1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。是[]否[]免[]5¹1-5:若函数或过程中的参数较长,则要进行适当的划分。是[]否[]免[

3、]6¹1-6:不允许把多个短语句写在一行中,即一行只写一条语句。是[]否[]免[]7¹1-7:if、while、for、default、do等语句自占一行。是[]否[]免[]8¹1-8:对齐只使用空格键,不使用TAB键。是[]否[]免[]9¹1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。是[]否[]免[]10¹1-10:程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语

4、句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while0、switch、case语句中的程序都要采用如上的缩进方式。是[]否[]免[]11¹1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。是[]否[]免[]2注释¹2-1:一般情况下,源程序有效注释量必须在20%以上。是[]否[]免[]¹2-2:说明性文件(如头文件.h文件、.inc文件、.def

5、文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。是[]否[]免[]¹2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。是[]否[]免[]¹2-4:函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。是[]否[]免[]¹2-5:边写代码边注释,修改代码同时修改相应的注释,以

6、保证注释与代码的一致性。不再有用的注释要删除。是[]否[]免[]¹2-6:注释的内容要清楚、明了,含义准确,防止注释二义性。是[]否[]免[]¹2-7:避免在注释中使用缩写,特别是非常用缩写。是[]否[]免[]¹2-8:注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。是[]否[]免[]¹2-9:对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释

7、应放在其上方相邻位置或右方。是[]否[]免[]¹2-10:数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。是[]否[]免[]¹2-11:全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。是[]否[]免[]¹2-12:注释与所描述内容进行同样的缩排。是[]否[]免[]¹2-13:将注释与其上面的代码用空行隔开。是[]否[]免[]¹2

8、-14:对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。是[]否[]免[]¹2-15:对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。是[]否[]免[]3标识符命名¹3-1:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。是[]否[]免[]¹3-2:命名中若使用

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。