程序代码优化命名规范调研V1.0[精选].docVIP

审核系统模块化 程序代码优化命名规范调研 技术部 刘宝萍 2013年5月21日 目录 一、调研目标 3 二、调研内容 3 2.1函数命名 3 2.2变量命名 3 2.3常量命名 5 2.4参数命名 5 2.5注释规范 5 三、参考文献 6 四、修改记录 6 一、调研目标 针对目前审核系统在代码编写方面缺乏规范化的问题，调研程序代码优化的命名规范，使编写的代码清楚化、逻辑化，为审核系统优化在代码编写方面提供规范。 二、调研内容 统一规范的命名风格能快速获知名字代表是什么甚至不需要去查找类型声明函数命名变量命名文件命名应具备描述性不要过度缩写类型和变量应该是名词, 函数名可以用 “命令性” 动词函数名用大写字母开头的单词组合而成。例如：void Draw(void); // 函数名void SetValue(int value); // 函数名用大写字母开头的单词组合而成例如：class Node; // 类名class LeafNode; // 类名TPI_SetFieldValueByName( )，其中前缀“TPI”标识该函数所在的类文件（TpiClient.h），清晰的指明了该函数所在的类。 2.2变量命名 【1】变量和参数用小写字母开头的单词组合而成。例如： BOOL flag; int drawMode; 【】静态变量加前缀s_（表示static）。例如：void Init(…) { static int s_initValue; // 静态变量…} 【】例如： int g_howManyPeople; // 全局变量int g_howMuchMoney; // 全局变量【】类的数据成员加前缀m_（表示member），这样可以避免数据成员与成员函数的参数同名。 例如： void Object::SetValue(int width, int height) { m_width = width; m_height = height; } 【】_width 【】width 【】前缀 类型 描述 ch char 8位字符 ch TCHAR 如果_UNICODE定义，则为16位字符 b BOOL 布尔值 n int 整型（其大小依赖于操作系统） n UINT 无符号值（其大小依赖于操作系统） w WORD 16位无符号值 l LONG 32位有符号整型 dw DWORD 32位无符号整型 p * 指针 lp FAR* 远指针 lpsz LPSTR 32位字符串指针 lpsz LPCSTR 32位常量字符串指针 lpsz LPCTSTR 如果_UNICODE定义，则为32位常量字符串指针 h handle Windows对象句柄 lpfn callback 指向CALLBACK函数的远指针 常量全用大写的字母，用下划线分割单词。例如： const int MAX = 100; const int MAX_LENGTH = 100; 2.4参数命名 参数无需添加前缀 2.5注释规范 函数注释皆添加在函数头文件中，具体规范如下： /** * @brief 函数名称： 函数功能介绍 * * @param[in ] 传入参数名: 参数介绍 * @param[out] 传出参数名: 参数介绍 * * @return 若函数执行成功 返回值 * 若函数执行失败 返回值 * * @author 时间 作者名 修改信息 * * @Note: 备注事宜 **/ 例： 三、参考文献 1. 文件TpiClient.h 2.审核系统模块优化调研 V1.2_李健勇.doc 3.编程精粹——Microsoft编写优质无错C程序秘诀 四、修改记录 修改时间、内容和编写人。 日期 编写人 编写内容 2013年5月21日 刘宝萍 程序代码优化命名规范调研 3