软件编程规范总CHECKLIST
检 查 :________________
检查日期:1999年_____月_____日
审查容:____________________________________________________________________
审查结果:通□ 通□
说 明:____________________________________________________________________
序号
总 条 款
执行情况
说明
1 排版
1
¹ 11:程序块采缩进风格编写缩进空格数4
[ ] 否[ ] 免[ ]
2
¹ 12:相独立程序块间变量说明必须加空行
[ ] 否[ ] 免[ ]
3
¹ 13:较长语句(>80字符)分成行书写长表达式低优先级操作符处划分新行操作符放新行首划分出新行进行适缩进排版整齐语句读
[ ] 否[ ] 免[ ]
4
¹ 14:循环判断等语句中较长表达式语句进行适应划分长表达式低优先级操作符处划分新行操作符放新行首
[ ] 否[ ] 免[ ]
5
¹ 15:函数程中参数较长进行适划分
[ ] 否[ ] 免[ ]
6
¹ 16:允许短语句写行中行写条语句
[ ] 否[ ] 免[ ]
7
¹ 17:ifwhilefordefaultdo等语句占行
[ ] 否[ ] 免[ ]
8
¹ 18:齐空格键TAB键
[ ] 否[ ] 免[ ]
9
¹ 19:函数程开始结构定义循环判断等语句中代码采缩进风格case语句情况处理语句遵语句缩进求
[ ] 否[ ] 免[ ]
序号
总 条 款
执行情况
说明
10
¹ 110:程序块分界符(CC++语言括号{’}’)应独占行位列时引语句左齐函数体开始类定义结构定义枚举定义iffordowhile0switchcase语句中程序采缩进方式
[ ] 否[ ] 免[ ]
11
¹ 111:两关键字变量常量进行等操作时间操作符前者前加空格进行非等操作时果关系密切立操作符(->)应加空格
[ ] 否[ ] 免[ ]
2 注释
¹ 21:般情况源程序效注释量必须20%
[ ] 否[ ] 免[ ]
¹ 22:说明性文件(头文件h文件inc文件def文件编译说明文件cfg等)头部应进行注释注释必须列出:版权说明版号生成日期作者容功文件关系修改日志等头文件注释中应函数功简说明
[ ] 否[ ] 免[ ]
¹ 23:源文件头部应进行注释列出:版权说明版号生成日期作者模块目功函数功修改日志等
[ ] 否[ ] 免[ ]
¹ 24:函数头部应进行注释列出:函数目功输入参数输出参数返回值调关系(函数表)等
[ ] 否[ ] 免[ ]
¹ 25:边写代码边注释修改代码时修改相应注释保证注释代码致性注释删
[ ] 否[ ] 免[ ]
¹ 26:注释容清楚明含义准确防止注释二义性
[ ] 否[ ] 免[ ]
¹ 27:避免注释中缩写特非常缩写
[ ] 否[ ] 免[ ]
¹ 28:注释应描述代码相代码注释应放方右方(单条语句注释)相邻位置放面放方需面代码空行隔开
[ ] 否[ ] 免[ ]
序号
总 条 款
执行情况
说明
¹ 29:物理含义变量常量果命名充分注释声明时必须加注释说明物理含义变量常量宏注释应放方相邻位置右方
[ ] 否[ ] 免[ ]
¹ 210:数结构声明(包括数组结构类枚举等)果命名充分注释必须加注释数结构注释应放方相邻位置放面结构中域注释放域右方
[ ] 否[ ] 免[ ]
¹ 211:全局变量较详细注释包括功取值范围函数程存取存取时注意事项等说明
[ ] 否[ ] 免[ ]
¹ 212:注释描述容进行样缩排
[ ] 否[ ] 免[ ]
¹ 213:注释面代码空行隔开
[ ] 否[ ] 免[ ]
¹ 214:变量定义分支语句(条件分支循环语句等)必须编写注释
[ ] 否[ ] 免[ ]
¹ 215:switch语句case语句果特殊情况需处理完case进入case处理必须该case语句处理完case语句前加明确注释
[ ] 否[ ] 免[ ]
3 标识符命名
¹ 31:标识符命名清晰明明确含义时完整单词家基理解缩写避免产生误解
[ ] 否[ ] 免[ ]
¹ 32:命名中特殊约定缩写注释说明
[ ] 否[ ] 免[ ]
¹ 33:特命名风格始终保持致回变化
[ ] 否[ ] 免[ ]
¹ 34:变量命名禁止取单字符(ijk)建议具体含义外表明变量类型数类型等ijk作局部循环变量允许
[ ] 否[ ] 免[ ]
¹ 35:命名规范必须系统风格保持致项目中统采UNIX全写加划线风格写混排方式写划线混排方式
[ ] 否[ ] 免[ ]
序号
总 条 款
执行情况
说明
4 读性
¹ 41:注意运算符优先级括号明确表达式操作序避免默认优先级
[ ] 否[ ] 免[ ]
¹ 42:避免易理解数字意义标识代涉物理状态者含物理意义常量应直接数字必须意义枚举宏代
[ ] 否[ ] 免[ ]
5 变量
¹ 51:掉没必公变量
[ ] 否[ ] 免[ ]
¹ 52:仔细定义明确公变量含义作取值范围公变量间关系
¹ 53:明确公变量操作公变量函数程关系访问修改创建等
¹ 54:公变量传递数时十分心防止赋合理值越界等现象发生
¹ 55:防止局部变量公变量名
¹ 56:严禁未初始化变量作右值
6 函数程
¹ 61:调函数错误返回码仔细全面处理
[ ] 否[ ] 免[ ]
¹ 62:明确函数功精确(似)实现函数设计
[ ] 否[ ] 免[ ]
¹ 63:编写重入函数时应注意局部变量(编写CC++语言重入函数时应auto缺省态局部变量寄存器变量)
[ ] 否[ ] 免[ ]
¹ 64:编写重入函数时全局变量应通关中断信号量(PV操作)等手段加保护
[ ] 否[ ] 免[ ]
7 测性
¹ 71:项目组产品组套统集成测试系统联调准备调测开关相应印函数详细说明
[ ] 否[ ] 免[ ]
序号
总 条 款
执行情况
说明
¹ 72:项目组产品组调测印出信息串格式统形式信息串中少模块名(源文件名)行号
[ ] 否[ ] 免[ ]
¹ 73:编程时单元测试选择恰测试点仔细构造测试代码测试例时出明确注释说明测试代码部分应作(模块中)子模块方便测试代码模块中安装拆卸(通调测开关)
[ ] 否[ ] 免[ ]
¹ 74:进行集成测试系统联调前构造测试环境测试项目测试例时仔细分析优化测试例提高测试效率
[ ] 否[ ] 免[ ]
¹ 75:断言发现软件问题提高代码测性
[ ] 否[ ] 免[ ]
¹ 76:断言检查程序正常运行时应发生调测时发生非法情况
[ ] 否[ ] 免[ ]
¹ 77:断言检查终产品肯定会出现必须处理错误情况
[ ] 否[ ] 免[ ]
¹ 78:较复杂断言加明确注释
[ ] 否[ ] 免[ ]
¹ 79:断言确认函数参数
[ ] 否[ ] 免[ ]
¹ 710:断言保证没定义特性功
[ ] 否[ ] 免[ ]
¹ 711:断言程序开发环境(OSCompilerHardware)假设进行检查
[ ] 否[ ] 免[ ]
¹ 712:正式软件产品中应断言调测代码掉(关调测开关关掉)
[ ] 否[ ] 免[ ]
¹ 713:软件系统中设置取消关测试手段软件实现功等产生影响
[ ] 否[ ] 免[ ]
¹ 714:调测开关切换软件DEBUG版正式版时存正式版DEBUG版源文件减少维护难度
[ ] 否[ ] 免[ ]
¹ 715:软件DEBUG版发行版应该统维护允许分家时刻注意保证两版实现功致性
[ ] 否[ ] 免[ ]
8 程序效率
¹ 81:编程时常注意代码效率
[ ] 否[ ] 免[ ]
序号
总 条 款
执行情况
说明
¹ 82:保证软件系统正确性稳定性读性测性前提提高代码效率
[ ] 否[ ] 免[ ]
¹ 83:局部效率应全局效率服务提高局部效率全局效率造成影响
[ ] 否[ ] 免[ ]
¹ 84:通系统数结构划分组织改进程序算法优化提高空间效率
[ ] 否[ ] 免[ ]
¹ 85:循环体工作量化
[ ] 否[ ] 免[ ]
9 质量保证
¹ 91:软件设计程中构筑软件质量
[ ] 否[ ] 免[ ]
¹ 92:代码质量保证优先原
[ ] 否[ ] 免[ ]
¹ 93:引属存贮空间
[ ] 否[ ] 免[ ]
¹ 94:防止引已释放存空间
[ ] 否[ ] 免[ ]
¹ 95:程函数中分配存程函数退出前释放
[ ] 否[ ] 免[ ]
¹ 96:程函数中申请(开文件)文件句柄程函数退出前关闭
[ ] 否[ ] 免[ ]
¹ 97:防止存操作越界
[ ] 否[ ] 免[ ]
¹ 98:认真处理程序遇种出错情况
[ ] 否[ ] 免[ ]
¹ 99:系统运行初初始化关变量运行环境防止未初始化变量引
[ ] 否[ ] 免[ ]
¹ 910:系统运行初加载系统中数进行致性检查
[ ] 否[ ] 免[ ]
¹ 911:严禁意更改模块系统关设置配置
[ ] 否[ ] 免[ ]
¹ 912:意改变模块接口
[ ] 否[ ] 免[ ]
¹ 913:充分解系统接口系统提供功
[ ] 否[ ] 免[ ]
¹ 914:编程时防止差1错误
[ ] 否[ ] 免[ ]
¹ 915:时刻注意易混淆操作符编完程序应头尾检查遍操作符防止拼写错误
[ ] 否[ ] 免[ ]
¹ 916:话if语句量加else分支没else分支语句心switch语句必须default分支
[ ] 否[ ] 免[ ]
序号
总 条 款
执行情况
说明
10 代码编辑编译审查
¹ 101:开编译器告警开关程序进行编译
[ ] 否[ ] 免[ ]
¹ 102:产品软件(项目组)中统编译开关选项
[ ] 否[ ] 免[ ]
¹ 103:通代码走读审查方式代码进行检查
[ ] 否[ ] 免[ ]
¹ 104:测试部测试产品前应代码进行抽查评审
[ ] 否[ ] 免[ ]
11 代码测试维护
¹ 111:单元测试求少达语句覆盖
[ ] 否[ ] 免[ ]
¹ 112:单元测试开始踪条语句观察数流变量变化
[ ] 否[ ] 免[ ]
¹ 113:清理整理优化代码审查测试
[ ] 否[ ] 免[ ]
¹ 114:代码版升级严格测试
[ ] 否[ ] 免[ ]
¹ 115:工具软件代码版进行维护
[ ] 否[ ] 免[ ]
¹ 116:正式版软件修改应详细文档记录
[ ] 否[ ] 免[ ]
12 宏
¹ 121:宏定义表达式时完备括号
[ ] 否[ ] 免[ ]
¹ 122宏定义条表达式放括号中
[ ] 否[ ] 免[ ]
¹ 123宏时允许参数发生变化
[ ] 否[ ] 免[ ]
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容,不代表《香当网》观点或立场,请自行判断内容的真实性和可靠性!
该内容是文档的文本内容,更好的格式请下载文档