软件编程规范CHECKLIST.doc

软件编程规范总则CHECKLIST
检查人:________________
检查日期:1999年_____月_____日
审查内容:____________________________________________________________________
审查结果:通过□不通过□
说明:____________________________________________________________________
序号
总则条款
执行情况
说明
1 排版
1
1-1:程序块要采用缩进风格编写,缩进的空格数为4个。
是[ ] 否[ ] 免[ ]
2
1-2:相对独立的程序块之间、变量说明之后必须加空行。
是[ ] 否[ ] 免[ ]
3
1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
是[ ] 否[ ] 免[ ]
4
1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
是[ ] 否[ ] 免[ ]
5
1-5:若函数或过程中的参数较长,则要进行适当的划分。
是[ ] 否[ ] 免[ ]
6
1-6:不允许把多个短语句写在一行中,即一行只写一条语句。
是[ ] 否[ ] 免[ ]
7
1-7:if、while、for、default、do等语句自占一行。
是[ ] 否[ ] 免[ ]
8
1-8:对齐只使用空格键,不使用TAB键。
是[ ] 否[ ] 免[ ]
9
1-9:函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case语句下的情况处理语句也要遵从语句缩进要求。
是[ ] 否[ ] 免[ ]
序号
总则条款
执行情况
说明
10
1-10:程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while0、switch、case语句中的程序都要采用如上的缩进方式。
是[ ] 否[ ] 免[ ]
11
1-11:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
是[ ] 否[ ] 免[ ]
2 注释
2-1:一般情况下,源程序有效注释量必须在20%以上。
是[ ] 否[ ] 免[ ]
2-2:说明性文件(、.inc文件、.def文件、)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
是[ ] 否[ ] 免[ ]
2-3:源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
是[ ] 否[ ] 免[ ]
2-4:函数头部应进行注释,列出:函数的目的/功能、输入