高质量C/C++编程指南总结(三)—— 命名规则
- 标识符应当直观,可望文知义。
- 标识符的长度应当符合“min-length && max-information” 原则。
- 命名规则尽量与所采用的操作系统或开发工具的风格保持一致。
- 程序中不要仅靠大小写区分相似的标识符。
- 程序中不要出现标识符完全相同的局部变量和全局变量。
- 变量的名字应当使用“名词”或者“形容词+名词”的结构。
- 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
- 尽量避免名字中出现数字编号,如 Value1,Value2 等,除非逻辑上的确需要编号。
- 全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。
- 类名和函数名用大写字母开头的单词组合而成。
- 变量和参数用小写字母开头的单词组合而成。
- 常量全用大写的字母,用下划线分割单词。
- 静态变量加前缀 s_(表示 static)。
- 如果不得已需要全局变量,则使全局变量加前缀 g_(表示 global)。
- 类的数据成员加前缀 m_(表示 member),这样可以避免数据成员与成员函数的参数同名。
- 为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性质的前缀。
例如三维图形标准 OpenGL 的所有库函数均以 gl 开头,所有常量(或宏定义)均以 GL 开头。