软件编程规范总则CHECKLIST

软件编程规范总则CHECKLIST
软件编程规范总则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、d| | | | |o、while0、switch、case语句中的程 | | | | |序都要采用如上的缩进方式。 | | | |11 |1-11：在两个以上的关键字、变量、常|是[ ] 否[ ] | | | |量进行对等操作时，它们之间的操作符|免[ ] | | | |之前、之后或者前后要加空格；进行非| | | | |对等操作时，如果是关系密切的立即操| | | | |作符（如－>），后不应加空格。 | | | |2 注释 | | |2-1：一般情况下，源程序有效注释量 |是[ ] 否[ ] | | | |必须在20％以上。 |免[ ] | | | |2-2：说明性文件（如头文件.h文件、.|是[ ] 否[ ] | | | |inc文件、.def文件、编译说明文件.cf|免[ ] | | | |g等）头部应进行注释，注释必须列出 | | | | |：版权说明、版本号、生成日期、作者| | | | |、内容、功能、与其它文件的关系、修| | | | |改日志等，头文件的注释中还应有函数| | | | |功能简要说明。 | | | | |2-3：源文件头部应进行注释，列出： |是[ ] 否[ ] | | | |版权说明、版本号、生成日期、作者、|免[ ] | | | |模块目的/功能、主要函数及其功能、 | | | | |修改日志等。 | | | | |2-4：函数头部应进行注释，列出：函 |是[ ] 否[ ] | | | |数的目的/功能、输入参数、输出参数 |免[ ] | | | |、返回值、调用关系（函数、表）等。| | | | |2-5：边写代码边注释，修改代码同时 |是[ ] 否[ ] | | | |修改相应的注释，以保证注释与代码的|免[ ] | | | |一致性。不再有用的注释要删除。 | | | | |2-6：注释的内容要清楚、明了，含义 |是[ ] 否[ ] | | | |准确，防止注释二义性。 |免[ ] | | | |2-7：避免在注释中使用缩写，特别是 |是[ ] 否[ ] | | | |非常用缩写。 |免[ ] | | | |2-8：注释应与其描述的代码相近，对 |是[ ] 否[ ] | | | |代码的注释应放在其上方或右方（对单|免[ ] | | | |条语句的注释）相邻位置，不可放在下| | | | |面，如放于上方则需与其上面的代码用| | | | |空行隔开。 | | | | |2-9：对于所有有物理含义的变量、常 |是[ ] 否[ ] | | | |量，如果其命名不是充分自注释的，在|免[ ] | | | |声明时都必须加以注释，说明其物理含| | | | |义。变量、常量、宏的注释应放在其上| | | | |方相邻位置或右方。 | | | | |2-10：数据结构声明(包括数组、结构 |是[ ] 否[ ] | | | |、类、枚举等)，如果其命名不是充分 |免[ ] | | | |自注释的，必须加以注释。对数据结构| | | | |的注释应放在其上方相邻位置，不可放| | | | |在下面；对结构中的每个域的注释放在| | | | |此域的右方。 | | | | |2-11：全局变量要有较详细的注释，包|是[ ] 否[ ] | | | |括对其功能、取值范围、哪些函数或过|免[ ] | | | |程存取它以及存取时注意事项等的说明| | | | |。 | | | | |2-12：注释与所描述内容进行同样的缩|是[ ] 否[ ] | | | |排。 |免[ ] | | | |2-13：将注释与其上面的代码用空行隔|是[ ] 否[ ] | | | |开。 |免[ ] | | | |2-14：对变量的定义和分支语句（条件|是[ ] 否[ ] | | | |分支、循环语句等）必须编写注释。 |免[ ] | | | |2-15：对于switch语句下的case语句，|是[ ] 否[ ] | | | |如果因为特殊情况需要处理完一个case|免[ ] | | | |后进入下一个case处理，必须在该case| | | | |语句处理完、下一个case语句前加上明| | | | |确的注释。 | | | |3 标识符命名 | | |3-1：标识符的命名要清晰、明了，有 |是[ ] 否[ ] | | | |明确含义，同时使用完整的单词或大家|免[ ] | | | |基本可以理解的缩写，避免使人产生误| | | | |解。 | | | | |3-2：命名中若使用特殊约定或缩写， |是[ ] 否[ ] | | | |则要有注释说明。 |免[ ] | | | |3-3：自己特有的命名风格，要自始至 |是[ ] 否[ ] | | | |终保持一致，不可来回变化。 |免[ ] | | | |3-4：对于变量命名，禁止取单个字符 |是[ ] 否[ ] | | | |（如i、j、k...），建议除了要有具体|免[ ] | | | |含义外，还能表明其变量类型、数据类| | | | |型等，但i、j、k作局部循环变量是允 | | | | |许的。 | | | | |3-5：命名规范必须与所使用的系统风 |是[ ] 否[ ] | | | |格保持一致，并在同一项目中统一，比|免[ ] | | | |如采用UNIX的全小写加下划线的风格或| | | | |大小写混排的方式，不要使用大小写与| | | | |下划线混排的方式。 | | | |4 可读性 | | |4-1：注意运算符的优先级，并用括号 |是[ ] 否[ ] | | | |明确表达式的操作顺序，避免使用默认|免[ ] | | | |优先级。 | | | | |4-2：避免使用不易理解的数字，用有 |是[ ] 否[ ] | | | |意义的标识来替代。涉及物理状态或者|免[ ] | | | |含有物理意义的常量，不应直接使用数| | | | |字，必须用有意义的枚举或宏来代替。| | | |5 变量 | | |5-1：去掉没必要的公共变量。 |是[ ] 否[ ] | | | | |免[ ] | | | |5-2：仔细定义并明确公共变量的含义 | | | | |、作用、取值范围及公共变量间的关系| | | | |。 | | | | |5-3：明确公共变量与操作此公共变量 | | | | |的函数或过程的关系，如访问、修改及| | | | |创建等。 | | | | |5-4：当向公共变量...
软件编程规范总则CHECKLIST