软件编程规范总则checklist.docxVIP

软件编程规范总则 CHECKLIST 检查人： 检查日期：1999年 月 日 审查内容： 审查结果：通过口 不通过口 说 明： 序 号 总则条款 执行情况 说明 1排版 1 11-1 :程序块要采用缩进风格编写，缩进的空格 数为4个。 是［ ］否［］免［ ] 2 11-2 :相对独立的程序块之间、变量说明之后必 须加空行。 是［ ］否［］免［ ] 3 11-3 :较长的语句（＞80字符）要分成多行书写， 长表达式要在低优先级操作符处划分新行，操作 符放在新行之首，划分出的新行要进行适当的缩 进，使排版整齐，语句可读。 是［ ］否［］免［ ] 4 11-4 :循环、判断等语句中右有较长的表达式或 语句，则要进行适应的划分，长表达式要在低优 先级操作符处划分新行，操作符放在新行之首。 是［ ］否［］免［ ] 5 11-5 :若函数或过程中的参数较长，则要进行适 当的划分。 是［ ］否［］免［ ] 6 11-6 :不允许把多个短语句写在一行中，即一行 只写一条语句。 是［ ］否［］免［ ] 7 11-7 : if、while、for、default 、do等语句自占 一行。 是［ ］否［］免［ ] 8 11-8 :对齐只使用空格键，不使用 TAB建。 是［ ］否［］免［ ] 9 11-9 :函数或过程的开始、结构的定义及循环、 判断等语句中的代码都要采用缩进风格， case语 句下的情况处理语句也要遵从语句缩进要求。 是［ ］否［］免［ ]  序 号 总则条款 执行情况 说明 10 11-10 :程序块的分界符（如 C/C++语言的大括号 {和’}）应各独占一行并且位于同一列， 同时与引用它们的语句左对齐。在函数体的开 始、类的定义、结构的定义、枚举的定义以及if、 for、do、while 0、switch、case语句中的程序 都要采用如上的缩进方式。 是［］否［］免［］ 11 11-11 :在两个以上的关键字、 变量、常量进行对 等操作时，它们之间的操作符之前、之后或者前 后要加空格；进行非对等操作时，如果是关系密 切的立即操作符（如一 ＞）,后不应加空格。 是［］否［］免［］ 2注释 12-1 : 一般情况下，源程序有效注释量必须在 20% 以上。 是［］否［］免［］ 12-2 :说明性文件（如头文件.h文件、.inc文 件、.def文件、编译说明文件.cfg等）头部应进 行注释，注释必须列出：版权说明、版本号、生 成日期、作者、内容、功能、与其它文件的关系、 修改日志等，头文件的注释中还应有函数功能简 要说明。 是［］否［］免［］ 12-3 :源文件头部应进行注释， 列出：版权说明、 版本号、生成日期、作者、模块目的 /功能、主 要函数及其功能、修改日志等。 是［］否［］免［］ 12-4 :函数头部应进行注释， 列出：函数的目的/ 功能、输入参数、输出参数、返回值、调用关系 （函数、表）等。 是［］否［］免［］ 12-5 :边写代码边注释，修改代码同时修改相应 的注释，以保证注释与代码的一致性。不再有用 的注释要删除。 是［］否［］免［］ 12-6 :注释的内容要清楚、明了，含义准确，防 止注释二义性。 是［］否［］免［］ 12-7 :避免在注释中使用缩写，特别是非常用缩 写。 是［］否［］免［］ 12-8 :注释应与其描述的代码相近，对代码的注 释应放在其上万或右万（对单条语句的注释）相 邻位置，不可放在卜面，如放于上方则需与其上 面的代码用空行隔开。 是［］否［］免［］  序 号 总则条款 执行情况 说明 12-9 :对于所有有物理言义的变量、常量，如果 其命名不是充分自注释的，在声明时都必须加以 注释，说明其物理含义。变量、常量、宏的注释 应放在其上万相邻位直或右万。 是［］否［］免［］ 12-10 :数据结构声明（包括数组、结构、类、枚 举等），如果其命名不是充分自注释的，必须加 以注释。对数据结构的注释应放在其上方相邻位 置，不可放在下面；对结构中的每个域的注释放 在此域的右方。 是［］否［］免［］ 12-11 :全局变量要有较详细的注释， 包括对其功 能、取值范围、哪些函数或过程存取它以及存取 时注意事项等的说明。 是［］否［］免［］ 12-12 :注释与所描述内容进行同样的缩排。 是［］否［］免［］ 12-13 :将注释与其上面的代码用空行隔开。 是［］否［］免［］ 12-14 :对变量的定义和分支语句（条件分支、循 环语句等）必须编写注释。 是［］否［］免［］ 12-15 :对于switch语句下的case语句，如果因为 特殊情况需要处理完一个 case后进入下一个 case处理，必须在该case语句处理完、下一个 case语句前加上明确的注释。 是［］否［］免［］ 3标识符命名 13-1 :标识