C++代码书写规范简介

冷不防 2022-08-31 15:23 215阅读 0赞

### C++代码书写规范简介 ###

编码规范并不是必须的，写代码遵守一定的规范，会使阅读代码修改bug轻松一些。

作为代码初学者，了解掌握最基本的代码书写规范知识是必要的。由于代码不仅仅是让程序执行，代码更是给人看的，层次分明清晰的代码和必要的注释的代码可读性更好，能够避免一些BUG或者更容易令人审查识别出BUG，为未来写大的程序和团队合作养成习惯打下基础。

这是个比较大的主题，细节很多，需要多借鉴多练习，不断地领悟。在此仅介绍基本的代码书写规范。特别提示，不同的团队的约定不尽相同。

**1、空格**

建议1：函数名之后不要留空格，紧跟左括号‘ （’，以与关键字区别。如：int Fun1(int x)

建议2：象 if、 for、 while等关键字之后应留一个空格再跟左括号‘ （’，以突出关键字。如： if (i = 0)

建议3：定义变量的逗号之后要留空格。在for语句中的分号其后要留空格。如：

int a, b;

for (i=0; i<5; i++)

建议4：赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“ =”、“ +=” “>=”、“ <=”、“ +”、“-”、“\*”、“ %”（求余运算符）、 “ &&”、“ <<”、 “ ^”等二元操作符的前后应当加空格。如： a = b; a += 10;

建议5：一元操作符如“ !”、“ ~”、“ ++”、“-”(负号运算符)、“\*”(指针运算符) “ &”（地址运算符）等前后不加空格。

【顺便提示：操作符也称为运算符，有些操作符有两种作用，如：

“-”，作为单目操作符“-”是负数操作符，作为算术操作符“-”是减法操作符。

“\*”，作为单目操作符“\*”是指针操作符，作为算术操作符“\*”是乘法操作符。】

**2、空行**

建议1：在实现函数时，函数与函数之间应加空行。如：

void Fun1(int x)  
\{  
　　//do something  
\}  
   
void Fun2(double y)  
\{  
　　//do something  
\}

建议2：在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行。

**3、变量名、函数名**

建议1：变量，函数，文件命名最好采用英文单词或词组，不要使用拼音，或者无意义的a b c之类的，用有意义的英文单词或其缩写命名能起到在缺少注释的情况下能够给阅读者起提示作用。

名规则：以大小驼峰式命名法为主,小写字母加下划线为辅

小驼峰法：第一个单字以小写字母开始，第二个单字的首字母大写。例如：firstName、lastName。

大驼峰法：每一个单字的首字母都采用大写字母，例如：FirstName、LastName、CamelCase。

建议2：类名和函数名用大写字母开头能和普通变量区分开。如：

class ReadBook;

void DrawImage();

建议3：变量和参数用小写字母开头的单词组合而成。如：

int value;

void SetValueMode(int valueMode);

建议4：常量全用大写的字母，用下划线分割单词。如：

const int MAX = 100;

const int MAX\_LENGTH = 100;

**4、注释**

C++中注释主要有两种，程序块的注释常采用“ /\*…\*/”，行注释一般采用“ //…”。注释主要用在3个地方。1、版权申明，2、函数说明，3、重要或复杂代码提示。

有时候读代码会跟不上编程者的思维，若代码旁边没有注释，就难以理解其意思，因此适当添加注释不仅能够让自己回忆某行、某段代码的用处，还能方面阅读者理解。建议边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要记得删除。

**5、缩进**

我们看到上面代码中输出语句和return 0;语句前面都有四个空格，这就是缩进。在必要的地方加入缩进，一般是\{ \}之间加入缩进，可以使代码更加清晰。

缩进一般是一个制表符（即键盘上的Tab键）或者四个空格，而小古银的习惯是制表符，由于网站会将制表符转换成四个空格，所以你看到的代码都是四个空格的。如：

int main()  
\{  
    if (…)  
    \{  
        while (…)  
    \}  
    return 0;  
\}

**附：**

google编程规范（中文）[https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/][https_zh-google-styleguide.readthedocs.io_en_latest_google-cpp-styleguide]

google编程规范（英文）[https://github.com/google/styleguide][https_github.com_google_styleguide]

[https_zh-google-styleguide.readthedocs.io_en_latest_google-cpp-styleguide]: https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/
[https_github.com_google_styleguide]: https://github.com/google/styleguide