本文共 1614 字，大约阅读时间需要 5 分钟。

C/C++代码命名规范

在软件开发过程中，代码的命名对于代码的可读性和维护性起着至关重要的作用。以下是一些关于C/C++代码命名的规范和建议，帮助开发者更好地组织和管理代码。

1. 类与结构体命名

• 类的命名：类的名称通常以大写字母“C”开头，后面跟着一个或多个单词。每个单词的首字母也应大写。例如：CArrayList，CFastVector。

• 推荐组成形式：类名通常采用“名词”或“形容词+名词”的形式。例如：CAnalyzer（分析器类），CFastVector（快速向量类）。

• 传统C结构体的命名：传统C语言中的结构体名称全部由大写字母组成，单词间使用下划线分隔。例如：SERVICE_STATUS（服务状态结构体），DRIVER_INFO（驱动信息结构体）。

2. 函数命名

• 函数的命名：函数名称由一个或多个单词组成，每个单词的首字母应大写。例如：getName()，setValue()，erase()，reserve()。
• 推荐组成形式：函数名通常采用“动词”或“动词+名词”（动宾词组）的形式。例如：getName()（获取名称），setValue()（设置值），erase()（擦除）。
• 保护成员函数：保护成员函数的开头应加上一个下划线“_”。例如：_setState()。
• 私有成员函数：私有成员函数的开头应加上两个下划线“__”。例如：__destroyImp()。
• 虚函数：虚函数通常以“Do”开头。例如：doRefresh()，_doEncryption()。
• 回调和事件处理函数：回调和事件处理函数通常以单词“On”开头。例如：_onTimer()，onExit()。

3. 变量命名

• 变量的命名：变量名由作用域前缀、类型前缀和一个或多个单词组成，每个单词的首字母应大写。对于局部变量，可以使用简化的方式命名，如：i，j，k，x，y，z等。
• 作用域前缀：作用域前缀用于标明变量的可见范围。常见的作用域前缀包括：
  • 无：局部变量
  • m_：类的成员变量（member）
  • sm_：类的静态成员变量（static member）
  • s_：静态变量（static）
  • g_：全局变量（global）
  • sg_：静态全局变量（static global）
  • gg_：进程间共享的共享数据段全局变量（global global）
• 类型前缀：类型前缀用于标明变量的类型。常见的类型前缀包括：
  • n：整型和位域变量（number）
  • e：枚举型变量（enumeration）
  • c：字符型变量（char）
  • b：布尔型变量（bool）
  • f：浮点型变量（float）
  • p：指针型变量和迭代子（pointer）
  • a：数组（array）
  • i：类的实例（instance）
  • ppn：指向整型的双重指针（pointer of pointer）
• 推荐组成形式：变量名通常采用“名词”或“形容词+名词”的形式。例如：nCode（代码编号），m_nState（成员的状态）。

4. 常量命名

• 常量的命名：常量名由类型前缀和全大写字母组成，单词间通过下划线分隔。例如：cDELIMITER（常量DELIMITER的字符），nMAX_BUFFER（常量MAX_BUFFER的大小）。

5. 枚举、联合与typedef

• 枚举、联合与typedef的命名：枚举、联合和typedef生成的类型名由全大写字母组成，单词间通过下划线分隔。例如：FAR_PROC（远程过程），ERROR_TYPE（错误类型）。

6. 宏与枚举值

• 宏与枚举值的命名：宏和枚举值的名称由全大写字母组成，单词间通过下划线分隔。例如：ERROR_UNKNOWN（未知错误），OP_STOP（操作停止）。

通过遵循上述命名规范，可以显著提升代码的可读性和可维护性，同时减少命名冲突和理解难度。在实际开发中，建议根据项目的具体需求和团队的命名习惯，制定更详细的命名规则，并结合项目特点进行适当调整。

转载地址：http://zuhfk.baihongyu.com/