DELPHI代码审核规范.doc

DELPHI代码审核规范 Contact [陆元会]：[Kingron@] [樊升]：[Sheng.Fan@] 目 录 1 说明 3 2 代码书写规范 3 2.1 单元文件 3 2.2 代码格式 3 2.3 注释 4 2.4 命名规则 4 2.5 表达式与基本语句 5 2.6 函数设计 5 3 代码质量规范 5 3.1 编译问题 5 3.2 变量 5 3.3 函数 6 3.4 指针 6 3.5 内存管理 6 3.6 类 7 3.7 异常处理 7 3.8 消息 7 3.9 锁 8 3.10 XML 8 3.11 流 8  说明 文档分为两部分，一部分是代码书写规范，一部分是代码质量规范，代码书写规范主要是检查代码格式，代码质量主要是总结日常代码中容易出错的部分。 代码书写规范 单元文件 审查项 备注 重要性 单元名称是否合理 单元名称前缀后缀是否有助于理解单元意义 重要 单元组织是否合理 把相同功能的单元文件放在相同目录下 重要 单元的引用是否混乱 单元文件应该尽可能独立，不能造成引用一个单元文件而导致引用很多单元文件 重要 单元头版权和版权申明是否完整 需要在单元文件添加版权说明 一般 单元备注是否完成 单元文件需要添加备注，需要有单元作者、备注、开发平台、兼容测试、本地化、更新记录 重要 单元结构是否合理 uses的单元是否另起一行，type定义的是否另起一行 重要 代码格式 审查项 备注 重要性 缩进 统一采用缩2的排列方式 重要 空行是否得体 空行应为划分逻辑的标志，否则尽量避免空行 重要 代码行内空格是否合理 代码行内空格应严格和DELPHI的标准代码一致，如：定义:之后空格；运算符前后各空一格 重要 长行拆分是否合理 拆行应以运算符、条件判断为准，并把运算符、条件判断写在下一行的开头，如果是函数参数，则直接把参数写在下一行开头，拆行都应缩2排列 重要 begin..end；if..else..end是否各占一行 不能把else begin放在一行，应是else占一行，begin占一行 一般 一行代码只做一件事 如定义一个变量，写一条语句，不能因为两条语句很短，而把两句并为一句 重要 类结构的private，protected，public顺序是否在所有程序中保持一致 应遵循先写private，后写protected，后续是public，不能同一个类中，出现几个private。 一般 代码是否严格遵守大小写 关键字、定义的变量都要严格遵守大小写 重要 注释 审查项 备注 重要性 是否有注释 逻辑复杂，或者需要注意的地方，一定要加注释 重要 注释是否规范 行注释使用//，块注释使用{*..*}，另外要禁止顶格的//，注释应保持代码的缩进风格，日常开发中不能使用Ctrl+/来进行块注释 重要 注释是否会导致误解 注释要求言简意赅，避免二义性，避免出现注释和代码不一致，在更新代码时，也要更新注释 重要 注释是否具有统一风格 如代码空一格后是注释，注释语句和//没有空格，块注释如下{* … *}，一般类定义一行注释使用{* *}，代码行注释使用// 一般 注释避免废话 有很多函数注释，写一大堆注释的分类，很多分类都没写，没写的这类注释都应去掉 重要 命名规则 审查项 备注 重要性 匈牙利命名法 DELPHI在Windows下采用匈牙利命名法，即加前缀来帮助理解，如定义dwLen: DWORD 重要 标识符是否直观且可以拼读 对单词的所写，应仅限于日常常用单词，如Length所写为Len，不常用单词应全写，即满足“Min Length && Max Information”原则 重要 命名是否规范 类名、类成员、函数参数、常量、全局变量的书写都应加前缀，类名加T，类成员加F，函数参数加A，常量加C，全局变量加G 重要 全局变量和局部变量不能重名，父函数和子函数变量不能重名 这样定义会导致歧义 一般 表达式与基本语句 审查项 备注 重要性 是否用括号来明确运算符（包括逻辑运算）执行顺序 如果代码行中运算符比较多，应该用括号来明确表达式的操作顺序 重要 禁止使用逻辑运算符的默认优先级 逻辑运算符的默认优先级很多，难以记住，因此代码中应用括号来明确优先级 重要 Case语句是否处理了else Case语句一定要处理else的情况 重要 函数设计 审查项 备注 重要性 参数命名、顺序是否合理参数的个数是否太多 备注 重要性 是否在函数体的“入口处”，是否用assert对参数的有效性进行检查 函数体内用Exit是否给函数返回值赋值了 没有初始化函数返回值，造成函数返回垃圾值 重要 是否使用const提高函数的健壮性const可以强制保护函数的参数“Use c