程序代码优化命名规范调研V10.doc

1 审核系统模块化 程序代码优化命名规范调研 技术部技术部 刘宝萍刘宝萍 2013 年年 5 月月 21 日日 2 目录目录 一 调研目标一 调研目标 3 二 调研内容二 调研内容 3 2 1 函数命名 3 2 2 变量命名 3 2 3 常量命名 5 2 4 参数命名 5 2 5 注释规范 5 三 参考文献三 参考文献 6 四 修改记录四 修改记录 6 3 一 调研目标 针对目前审核系统在代码编写方面缺乏规范化的问题 调研程序代码优化的命名 规范 使编写的代码清楚化 逻辑化 为审核系统优化在代码编写方面提供规范 二 调研内容 统一规范的命名风格能快速获知名字代表是什么 甚至不需要去查找类型声明 一套定义完整 结构清晰明了的命名规范将大大提升源代码的可读性和软件的可维护 性 目前流行的命名规范包括 谷歌命名规范 匈牙利命名规范及骆驼命名法等 使 用统一的命名规范 通过在数据和函数名中加入额外的信息 以增强程序员对程序的 理解 减少维护的时间 例如 定义 char pch 当别的程序员看到某个函数里有一个 名为 pch 的变量时 不用查看声明就立即知道它是一个指向字符的指针 一般来说 函数命名 变量命名 文件命名应具备描述性 不要过度缩写 类型 和变量应该是名词 函数名可以用 命令性 动词 2 12 1 函数命名函数命名 1 函数名用大写字母开头的单词组合而成 每个英文单词的首字母大写 清晰 可读 例如 void Draw void 函数名 void SetValue int value 函数名 2 类名也是用大写字母开头的单词组合而成 例如 class Node 类名 class LeafNode 类名 3 通常一个类中的函数 会在其他类中被调用 定义该类的函数时 函数名称 前面应加上类前缀 例如 通过字段名称设置字段的值函数 TPI SetFieldValueByName 其中前缀 TPI 标识该函数所在的类文件 TpiClient h 清晰的指明了该函数所在的类 4 2 22 2 变量变量命名命名 1 变量和参数用小写字母开头的单词组合而成 例如 BOOL flag int drawMode 2 静态变量加前缀 s 表示 static 例如 void Init static int s initValue 静态变量 3 全局变量前添加 g 例如 int g howManyPeople 全局变量 int g howMuchMoney 全局变量 不过 应尽量少使用全局变量 因为 a 全局变量在程序全部执行过程中占用存 储单元 b 降低了函数的通用性 可靠性 可移植性 容易出错 4 类的数据成员加前缀 m 表示 member 这样可以避免数据成员与成员函 数的参数同名 例如 void Object SetValue int width int height m width width m height height 5 临时变量前添加 如定义临时变量宽度 width 6 形参无添加 如定义形式参数宽度 width 5 7 变量前缀变量前缀 前缀前缀类型类型描述描述 chchar8 位字符 chTCHAR如果 UNICODE 定义 则为 16 位字符 bBOOL布尔值 nint整型 其大小依赖于操作系统 nUINT无符号值 其大小依赖于操作系统 wWORD16 位无符号值 lLONG32 位有符号整型 dwDWORD32 位无符号整型 p 指针 lpFAR 远指针 lpszLPSTR32 位字符串指针 lpszLPCSTR32 位常量字符串指针 lpszLPCTSTR如果 UNICODE 定义 则为 32 位常量字符串指 针 hhandleWindows 对象句柄 lpfncallback指向 CALLBACK 函数的远指针 例 一个服务器句柄的全局变量 应命名为 g hCon 2 32 3 常量命名常量命名 常量全用大写的字母 用下划线分割单词 例如 const int MAX 100 const int MAX LENGTH 100 2 2 4 4 参数参数命名命名 参数无需添加前缀 2 2 5 5 注释规范注释规范 函数注释皆添加在函数头文件中 具体规范如下 6 brief函数名称 函数功能介绍 param in 传入参数名 参数介绍 param out 传出参数名 参数介绍 return若函数执行成功返回值 若函数执行失败返回值 author时间作者名修改信息 Note 备注事宜 例 三 参考文献 1 文件 TpiClient h 2 20130514 审核系统模块优化调研 V1 2