软件代码审查报告_第1页
软件代码审查报告_第2页
全文预览已结束

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

1、精选优质文档-倾情为你奉上精选优质文档-倾情为你奉上专心-专注-专业专心-专注-专业精选优质文档-倾情为你奉上专心-专注-专业软件代码审查报告检查人：检查日期：审查内容：审查总结果：说明：审查类型序号条款与说明审查结果一、注释1源代码有效注释量必须达到20%以上2程序文件头部应进行注释，务必列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。3有头文件没有源文件的要说明4函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系等。5编写代码边注释6注释的内容要清楚、明了，含义明确，防止注释二义性7避免在注释中使用缩写，特别是非常用缩写8

2、注释应与其描述的代码相近，对代码的注释应放在其上方或右方相邻位置。9数据结构申明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。10全局变量要有交详细的注释，包括对其功能、取值范围。11对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。二、标识符命名1标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。2命名中若使用特殊约定或缩写，则要有注释说明。3自己特有的命名风格，要自始至终保持一致，不可来回变化。4对于变量命名，禁止取单个字符（如i、j、k.），建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。5命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式。三、可读性1注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级2避免使用不易理解的数字，用有意义的标识来替代。

人人文库> 全部分类> 教育资料 > 辅导培训

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论