【C++】C++的命名规则

小鱼儿 2022-04-16 01:48 236阅读 0赞

**参考链接**：[**Here**][Here]  
**C++命名规则**  
如果想要管理一个稍微复杂一点的体系，针对其中的事物的一套**统一、带有层次、清晰明了**的命令准则就必不可少而且非常好的工具。  
活跃在生物学、化学、军队等各个领域内的大量有识先辈们都曾无数次以实际行动证明了以上的公理的正确性。**除了上帝（假设他可以改变世界万物的秩序）以外，相信没有人有实力对它不屑一顾。**  
在软件开发这一高度抽象而且十分复杂的活动中，命令规则的重要性更显得尤为突出。一套定义梁浩并且完整的，在整个项目中统一使用命令规范将大大提升源代码的可读性和软件的可维护性。  
在引入细节之前，先说明一下命令规则的整体原则：

<table> 
 <thead> 
 <tr> 
 <th></th> 
 <th></th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>同一性</td> 
 <td>在编写一个子模块或者派生类的时候，需要遵循其基类或整体模块的命令风格，保持命令风格在整体模块的同一性。</td> 
 </tr> 
 <tr> 
 <td>标识符组成</td> 
 <td>标识符采用英文单词或其组合，应当直观且可以拼读，可望文知意，用词应当准确。</td> 
 </tr> 
 <tr> 
 <td>最小化长度&amp;&amp;最大化信息量原则</td> 
 <td>在保持一个标识符明确意思的同时，应该尽量缩短其长度。</td> 
 </tr> 
 <tr> 
 <td>避免过于相似</td> 
 <td>不要出现紧靠大小写区分的标识符，例如“i”与“I”,“function”与“Function”等。</td> 
 </tr> 
 <tr> 
 <td>避免在不同级别的作用域的重名</td> 
 <td>程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法的错误，但是容易使人误解。</td> 
 </tr> 
 <tr> 
 <td>正确命名具有互斥意义的标识符</td> 
 <td>用正确的反义词命名具有互斥意义的标识符，如：“nMinValue"和"nMaxValue”,"GetName()“和"SetName()”</td> 
 </tr> 
 <tr> 
 <td>避免名字出现数字编号</td> 
 <td>尽量避免名字出现数字的编号，如Value0、Value1、Value2等，除非逻辑上的确需要编号。这是为了防止程序偷懒，不肯为命名动脑筋从而导致了产生无意义的名字（因为用数字编号最省事）。</td> 
 </tr> 
 </tbody> 
</table>

**类/结构**  
除了异常类等个别情况（不希望用户把类看作一个普通的、正常类的情况）外，C++类结构的命名应该遵循以下准则：

<table> 
 <thead> 
 <tr> 
 <th></th> 
 <th></th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>C++类/结构的命名</td> 
 <td>类的名字都要以大写的字母“C”开头，后跟一个或多个单词。为便于界定，每个单词的首字母需要大写。</td> 
 </tr> 
 <tr> 
 <td>推荐的组织形式</td> 
 <td>类的命名推荐用“名词”或者“形容词+名词”的形式，例如：“CAnalyzer”、“CFVecteor” …</td> 
 </tr> 
 </tbody> 
</table>

不同于C++类的概念，传统的C结构体的命名规则如下：

<table> 
 <thead> 
 <tr> 
 <th></th> 
 <th></th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>传统的C的命名规则</td> 
 <td>传统C结构体的名称全部由大写字母组成，单词间使用下划线界定，例如:“SERVICE_STATUS”,“DRIVER_INFO”…</td> 
 </tr> 
 </tbody> 
</table>

**函数**

<table> 
 <thead> 
 <tr> 
 <th></th> 
 <th></th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>函数的命名</td> 
 <td>函数的名称由一个或者多个单词组成。便于界定，每个单词的首字母要大写。</td> 
 </tr> 
 <tr> 
 <td>推荐的组织形式</td> 
 <td>函数名应该使用“动词”或者“动词+名词”（动宾词组）形式。例如:“GetName()”、“SetName()”、“Erase()”、“Reserve()”…</td> 
 </tr> 
 <tr> 
 <td>保护成员函数</td> 
 <td>保护成员函数的开头应当加上一个下划线“_“以示区分，例如”_SetState()”…</td> 
 </tr> 
 <tr> 
 <td>私有成员函数</td> 
 <td>类似地，私有成员函数的开头应当加上两个下划线“__”,例如“__DestroyImp()”…</td> 
 </tr> 
 <tr> 
 <td>虚函数</td> 
 <td>虚函数习惯用"Do"开头，如：“DoRefresh()”,"_DoEncryption()"…</td> 
 </tr> 
 <tr> 
 <td>回调和事件处理函数</td> 
 <td>回调和事件处理函数习惯以单词"On"开头。例如："_OnTimer()",“OnExit()”</td> 
 </tr> 
 </tbody> 
</table>

**变量**  
变量应该是程序中使用最多的标识符了，变量的命名规范可能是一套C++命名准则中最重要的部分。

<table> 
 <tbody> 
 <tr> 
 <td>变量的命名</td> 
 <td>变量名由作用于前缀+类型的缀+一个或多个单词组成。为了便于界定，每个单词的首字母要大写。对于某些用途简单明了的局部变量，也可以使用简化的方式，如：i,j,k,x,y,z...</td> 
 </tr> 
 <tr></tr> 
 <tr> 
 <td>作用域前缀</td> 
 <td> 作用域前缀标明了一个变量的可见范围。作用域可以有以下几种： 
 <table> 
 <tbody> 
 <tr> 
 <td>前缀</td> 
 <td>说明</td> 
 </tr> 
 <tr> 
 <td>无</td> 
 <td>局部变量</td> 
 </tr> 
 <tr> 
 <td>m_</td> 
 <td>类的成员变量（member）</td> 
 </tr> 
 <tr> 
 <td>sm_</td> 
 <td>类的静态成员变量（static member）</td> 
 </tr> 
 <tr> 
 <td>s_</td> 
 <td>静态变量（static）</td> 
 </tr> 
 <tr> 
 <td>g_</td> 
 <td>外部全局变量（global）</td> 
 </tr> 
 <tr> 
 <td>sg_</td> 
 <td>静态全局变量（static global）</td> 
 </tr> 
 <tr> 
 <td>sg_</td> 
 <td>静态全局变量（static global）</td> 
 </tr> 
 <tr> 
 <td>gg_</td> 
 <td>进程间共享的数据段全局变量(global global)</td> 
 </tr> 
 </tbody> 
 </table> 除非不得已，否则应该尽可能少用全局变量。 </td> 
 </tr> 
 <tr> 
 <td>类型的缀</td> 
 <td> 
 <table> 
 <tbody> 
 <tr> 
 <td>前缀</td> 
 <td>说明</td> 
 </tr> 
 <tr> 
 <td>n</td> 
 <td>整型和位域变量(number)</td> 
 </tr> 
 <tr> 
 <td>e</td> 
 <td>枚举型变量(enumeration)</td> 
 </tr> 
 <tr> 
 <td>c</td> 
 <td>字符型变量(char)</td> 
 </tr> 
 <tr> 
 <td>b</td> 
 <td>布尔型变量(bool)</td> 
 </tr> 
 <tr> 
 <td>f</td> 
 <td>浮点型变量(float)</td> 
 </tr> 
 <tr> 
 <td>p</td> 
 <td>指针型变量和迭代子(pointer)</td> 
 </tr> 
 <tr> 
 <td>pfn</td> 
 <td>特别针对指向函数指针变量和函数指针(pointer of function)</td> 
 </tr> 
 <tr> 
 <td>g</td> 
 <td>数组(grid)</td> 
 </tr> 
 <tr> 
 <td>i</td> 
 <td>类的实例(instance)对于经常用到的类，也可以定义一些专门的前缀，如:std::string和std::wstring类的前缀可以定义为"st",std::vector类的前缀可以定义为"v"等等</td> 
 </tr> 
 </tbody> 
 </table> 类型的缀可以组合使用，例如"gc"表示字符数组，"ppn"表示指向整型的指针的指针等等。 </td> 
 </tr> 
 <tr> 
 <td>推荐的组成形式</td> 
 <td>变量的名字应当使用"名词"或者"形容词+名词"。例如:"nCode","m_nState","nMaxWidth"...</td> 
 </tr> 
 </tbody> 
</table>

**常量**  
C++引入了对常量的支持，常量的命名规则如下：

<table> 
 <thead> 
 <tr> 
 <th></th> 
 <th></th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>常量的命名规则</td> 
 <td>常量名由类型前缀+全大写字母组成，单词间通过下划线来界定，如cDELIMITER,nMAX_BUFFER…类型前缀的定义和变量命名规则中的相同。</td> 
 </tr> 
 </tbody> 
</table>

**枚举、联合、typedef**

<table> 
 <thead> 
 <tr> 
 <th></th> 
 <th></th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>枚举、联合以及typdef的命名</td> 
 <td>枚举、联合以及typedef语句生成的类型名全都是大写字母组成，单词间通过下划线界定，如：FAR_PROC,ERROR_TYPE…</td> 
 </tr> 
 </tbody> 
</table>

**宏、枚举值**

<table> 
 <thead> 
 <tr> 
 <th></th> 
 <th></th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>宏、枚举值的命名</td> 
 <td>宏和枚举值全大写字母组成，单词通过下划线界定，如:ERROR_UNKNOWN,OP_STOP…</td> 
 </tr> 
 </tbody> 
</table>

[Here]: https://www.cnblogs.com/heyonggang/p/3362873.html