软件编程规范总则(DOC 8)18862.docx

软件编程规范总则CHECKLIST检 查 人：_ 检查日期：19999年_月月_日日审查内容：_审查结果：通过 不通通过说 明：_序号总 则 条条 款执行情况说明1 排版1¹ 1-1：程程序块要要采用缩缩进风格格编写，缩缩进的空空格数为为4个。是 否否 免 2¹ 1-2：相相对独立立的程序序块之间间、变量量说明之之后必须须加空行行。是 否否 免 3¹ 1-3：较较长的语语句（>>80字字符）要要分成多多行书写写，长表表达式要要在低优优先级操操作符处处划分新新行，操操作符放放在新行行之首，划划分出的的新行要要进行适适当的缩缩进，使使排版整整齐，语语句可读读。是 否否 免 4¹ 1-4：循循环、判判断等语语句中若若有较长长的表达达式或语语句，则则要进行行适应的的划分，长长表达式式要在低低优先级级操作符符处划分分新行，操操作符放放在新行行之首。是 否否 免 5¹ 1-5：若若函数或或过程中中的参数数较长，则则要进行行适当的的划分。是 否否 免 6¹ 1-6：不不允许把把多个短短语句写写在一行行中，即即一行只只写一条条语句。是 否否 免 7¹ 1-7：iif、whiile、forr、deffaullt、do等语语句自占占一行。是 否否 免 8¹ 1-8：对对齐只使使用空格格键，不不使用TTAB键键。是 否否 免 9¹ 1-9：函函数或过过程的开开始、结结构的定定义及循循环、判判断等语语句中的的代码都都要采用用缩进风风格，ccasee语句下下的情况况处理语语句也要要遵从语语句缩进进要求。是 否否 免 10¹ 1-10：程序块块的分界界符（如如C/CC+语语言的大大括号和）应各各独占一一行并且且位于同同一列，同同时与引引用它们们的语句句左对齐齐。在函函数体的的开始、类类的定义义、结构构的定义义、枚举举的定义义以及iif、forr、do、whiile00、swiitchh、casse语句句中的程程序都要要采用如如上的缩缩进方式式。是 否否 免 11¹ 1-11：在两个个以上的的关键字字、变量量、常量量进行对对等操作作时，它它们之间间的操作作符之前前、之后后或者前前后要加加空格；进行非非对等操操作时，如如果是关关系密切切的立即即操作符符（如>），后后不应加加空格。是 否否 免 2 注释¹ 2-1：一一般情况况下，源源程序有有效注释释量必须须在200以上上。是 否否 免 ¹ 2-2：说说明性文文件（如如头文件件.h文件件、.iinc文文件、.deff文件、编编译说明明文件.cfgg等）头头部应进进行注释释，注释释必须列列出：版版权说明明、版本本号、生生成日期期、作者者、内容容、功能能、与其其它文件件的关系系、修改改日志等等，头文文件的注注释中还还应有函函数功能能简要说说明。是 否否 免 ¹ 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：对于sswittch语语句下的的casse语句句，如果果因为特特殊情况况需要处处理完一一个caase后后进入下下一个ccasee处理，必必须在该该casse语句句处理完完、下一一个caase语语句前加加上明确确的注释释。是 否否 免 3 标识符符命名¹ 3-1：标标识符的的命名要要清晰、明明了，有有明确含含义，同同时使用用完整的的单词或或大家基基本可以以理解的的缩写，避避免使人人产生误误解。是 否否 免 ¹ 3-2：命命名中若若使用特特殊约定定或缩写写，则要要有注释释说明。是 否否 免 ¹ 3-3：自自己特有有的命名名风格，要要自始至至终保持持一致，不不可来回回变化。是 否否 免 ¹ 3-4：对对于变量量命名，禁禁止取单单个字符符（如ii、j、k.），建建议除了了要有具具体含义义外，还还能表明明其变量量类型、数数据类型型等，但但i、j、k作局部部循环变变量是允允许的。是 否否 免 ¹ 3-5：命命名规范范必须与与所使用用的系统统风格保保持一致致，并在在同一项项目中统统一，比比如采用用UNIIX的全全小写加加下划线线的风格格或大小小写混排排的方式式，不要要使用大大小写与与下划线线混排的的方式。是 否否 免 4 可读性性¹ 4-1：注注意运算算符的优优先级，并并用括号号明确表表达式的的操作顺顺序，避避免使用用默认优优先级。是 否否 免 ¹ 4-2：避避免使用用不易理理解的数数字，用用有意义义的标识识来替代代。涉及及物理状状态或者者含有物物理意义义的常量量，不应应直接使使用数字字，必须须用有意意义的枚枚举或宏宏来代替替。是 否否 免 5 变量¹ 5-1：去去掉没必必要的公公共变量量。是 否否 免 ¹ 5-2：仔仔细定义义并明确确公共变变量的含含义、作作用、取取值范围围及公共共变量间间的关系系。¹ 5-3：明明确公共共变量与与操作此此公共变变量的函函数或过过程的关关系，如如访问、修修改及创创建等。¹ 5-4：当当向公共共变量传传递数据据时，要要十分小小心，防防止赋与与不合理理的值或或越界等等现象发发生。¹ 5-5：防防止局部部变量与与公共变变量同名名。¹ 5-6：严严禁使用用未经初初始化的的变量作作为右值值。6 函数、过过程¹ 6-1：对对所调用用函数的的错误返返回码要要仔细、全全面地处处理。是 否否 免 ¹ 6-2：明明确函数数功能，精精确（而而不是近近似）地地实现函函数设计计。是 否否 免 ¹ 6-3：编编写可重重入函数数时，应应注意局局部变量量的使用用(如编写写C/CC+语语言的可可重入函函数时，应应使用aautoo即缺省省态局部部变量或或寄存器器变量)。是 否否 免 ¹ 6-4：编编写可重重入函数数时，若若使用全全局变量量，则应应通过关关中断、信信号量（即即P、V操作）等等手段对对其加以以保护。是 否否 免 7 可测性性¹ 7-1：在在同一项项目组或或产品组组内，要要有一套套统一的的为集成成测试与与系统联联调准备备的调测测开关及及相应打打印函数数，并且且要有详详细的说说明。是 否否 免 ¹ 7-2：在在同一项项目组或或产品组组内，调调测打印印出的信信息串的的格式要要有统一一的形式式。信息息串中至至少要有有所在模模块名（或或源文件件名）及及行号。是 否否 免 ¹ 7-3：编编程的同同时要为为单元测测试选择择恰当的的测试点点，并仔仔细构造造测试代代码、测测试用例例，同时时给出明明确的注注释说明明。测试试代码部部分应作作为（模模块中的的）一个个子模块块，以方方便测试试代码在在模块中中的安装装与拆卸卸（通过过调测开开关）。是 否否 免 ¹ 7-4：在在进行集集成测试试/系统联联调之前前，要构构造好测测试环境境、测试试项目及及测试用用例，同同时仔细细分析并并优化测测试用例例，以提提高测试试效率。是 否否 免 ¹ 7-5：使使用断言言来发现现软件问问题，提提高代码码可测性性。是 否否 免 ¹ 7-6：用用断言来来检查程程序正常常运行时时不应发发生但在在调测时时有可能能发生的的非法情情况。是 否否 免 ¹ 7-7：不不能用断断言来检检查最终终产品肯肯定会出出现且必必须处理理的错误误情况。是 否否 免 ¹ 7-8：对对较复杂杂的断言言加上明明确的注注释。是 否否 免 ¹ 7-9：用用断言确确认函数数的参数数。是 否否 免 ¹ 7-10：用断言言保证没没有定义义的特性性或功能能不被使使用。是 否否 免 ¹ 7-11：用断言言对程序序开发环环境（OOS/CComppileer/HHarddwarre）的的假设进进行检查查。是 否否 免 ¹ 7-12：正式软软件产品品中应把把断言及及其它调调测代码码去掉（即即把有关关的调测测开关关关掉）。是 否否 免 ¹ 7-13：在软件件系统中中设置与与取消有有关测试试手段，不不能对软软件实现现的功能能等产生生影响。是 否否 免 ¹ 7-14：用调测测开关来来切换软软件的DDEBUUG版和和正式版版，而不不要同时时存在正正式版本本和DEEBUGG版本的的不同源源文件，以以减少维维护的难难度。是 否否 免 ¹ 7-15：软件的的DEBBUG版版本和发发行版本本应该统统一维护护，不允允许分家家，并且且要时刻刻注意保保证两个个版本在在实现功功能上的的一致性性。是 否否 免 8 程序效效率¹ 8-1：编编程时要要经常注注意代码码的效率率。是 否否 免 ¹ 8-2：在在保证软软件系统统的正确确性、稳稳定性、可可读性及及可测性性的前提提下，提提高代码码效率。是 否否 免 ¹ 8-3：局局部效率率应为全全局效率率服务，不不能因为为提高局局部效率率而对全全局效率率造成影影响。是 否否 免 ¹ 8-4：通通过对系系统数据据结构的的划分与与组织的的改进，以以及对程程序算法法的优化化来提高高空间效效率。是 否否 免 ¹ 8-5：循循环体内内工作量量最小化化。是 否否 免 9 质量保保证¹ 9-1：在在软件设设计过程程中构筑筑软件质质量。是 否否 免 ¹ 9-2：代代码质量量保证优优先原则则是 否否 免 ¹ 9-3：只只引用属属于自己己的存贮贮空间。是 否否 免 ¹ 9-4：防防止引用用已经释释放的内内存空间间。是 否否 免 ¹ 9-5：过过程/函数中中分配的的内存，在在过程/函数退退出之前前要释放放。是 否否 免 ¹ 9-6：过过程/函数中中申请的的(为打开开文件而而使用的的)文件句句柄，在在过程/函数退退出之前前要关闭闭。是 否否 免 ¹ 9-7：防防止内存存操作越越界。是 否否 免 ¹ 9-8：认认真处理理程序所所能遇到到的各种种出错情情况。是 否否 免 ¹ 9-9：系系统运行行之初，要要初始化化有关变变量及运运行环境境，防止止未经初初始化的的变量被被引用。是 否否 免 ¹ 9-10：系统运运行之初初，要对对加载到到系统中中的数据据进行一一致性检检查。是 否否 免 ¹ 9-11：严禁随随意更改改其它模模块或系系统的有有关设置置和配置置。是 否否 免 ¹ 9-12：不能随随意改变变与其它它模块的的接口。是 否否 免 ¹ 9-13：充分了了解系统统的接口口之后，再再使用系系统提供供的功能能。是 否否 免 ¹ 9-14：编程时时，要防防止差11错误。是 否否 免 ¹ 9-15：要时刻刻注意易易混淆的的操作符符。当编编完程序序后，应应从头至至尾检查查一遍这这些操作作符，以以防止拼拼写错误误。是 否否 免 ¹ 9-16：有可能能的话，if语句尽量加上else分支，对没有else分支的语句要小心对待；switch语句必须有default分支。是 否否 免 10 代码码编辑、编编译、审审查¹ 10-1：打开编编译器的的所有告告警开关关对程序序进行编编译。是 否否 免 ¹ 10-2：在产品品软件（项项目组）中中，要统统一编译译开关选选项。是 否否 免 ¹ 10-3：通过代代码走读读及审查查方式对对代码进进行检查查。是 否否 免 ¹ 10-4：测试部部测试产产品之前前，应对对代码进进行抽查查及评审审。是 否否 免 11 代码码测试、维维护¹ 11-1：单元测测试要求求至少达达到语句句覆盖。是 否否 免 ¹ 11-2：单元测测试开始始要跟踪踪每一条条语句，并并观察数数据流及及变量的的变化。是 否否 免 ¹ 11-3：清理、整整理或优优化后的的代码要要经过审审查及测测试。是 否否 免 ¹ 11-4：代码版版本升级级要经过过严格测测试。是 否否 免 ¹ 11-5：使用工工具软件件对代码码版本进进行维护护。是 否否 免 ¹ 11-6：正式版版本上软软件的任任何修改改都应有有详细的的文档记记录。是 否否 免 12 宏¹ 12-1：用宏定定义表达达式时，要要使用完完备的括括号。是 否否 免 ¹ 12-2:将宏所所定义的的多条表表达式放放在大括括号中。是 否否 免 ¹ 12-3:使用宏宏时，不不允许参参数发生生变化。是 否否 免