C++代码书写规范

（声明：本博客参考自简书网页https://www.jianshu.com/p/c1b6cf190e0b   以下内容是读后结合本人编程经验分享我对代码规范的理解和建议）

　一、前述

　　代码作为程序员与计算机沟通的工具，其重要性不言而喻，但在漫漫的编程长路中，不可能一直是自主编程的，小组合作是必不可少的。因此，代码的规范性由此就显得十分重要，倘若你书写了不规范、给人以直观丑陋感，那么你的搭档就难以修改你书写的代码，甚至会拒绝合作。因此，作为代码初学者，掌握必要的代码规范知识是最基本的，本博客以c++为例子，举例分析代码规范。

　二、实例分析

1. 善用空格与空行

　　①正确使用空格和空行能给人以舒适感，而不是一连串紧密的代码给人的压迫感。

　　函数名之后不要留空格，否则形参表示不明显

　　如：int Fun1(int x)  //建议书写

　　　　int Fun2 (int x)  //不建议书写

 

　　②if、 for、 while等判断和循环使用到的关键字之后应留一个空格再跟左括号‘ （’，以突出关键字。

　　如： if (i = 0)

 

　　③定义变量的逗号之后要留空格。在for语句中的分号其后要留空格。

　　如：

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

　　    int a, b;

 

 

　　④赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“ =”、“ +=” “>=”、“ <=”、“ +”、“ *”、“ %”、“ &&”、“ <<”、 “ ^”等前后应当加空格。

　　如： a = b; a += 10;

 

　　⑤在实现函数时，函数与函数之间应加空行，以方便区分两个不同的函数。

　　如：

 void Fun1(int x)

　　{

　　　　//do something

　　}

 

　　void Fun2(double y)

　　{

　　　　//do something

　　}

 

 

　　PS: 过分使用空格也不是好的代码规范，应适当使用，如这样就不合适：for( int i = 0 ; i < 10 ; i ++ ) 这样滥用空格给人很空的感觉。

 

2. 注意每行代码的内容

　　一行代码就做一件事情，不要将所有功能压缩至一行语句中。

　　如： 

int main()

　　{

　　　　int num; double count; while (num <= 100) num++; return 0;　　//不好的代码规范

　　}

　　　　int main()

　　{

　　　　int num;

　　　　double count;

　　　　while(num <= 100)

　　{

　　　　num++;

　　}

　　　　return 0;

　　}

 

 

3. 变量、函数名命名规范

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

　　②类名和函数名用大写字母开头能和普通变量区分开。

　　个人喜爱使用的命名规范：双驼峰命名法：

　　双驼峰命名法就是当变量名由多个单词组合而成时，第一个单词以小写字母开始，第二、三、四……N个单词的首字母大写。例如：myFirstWord，这样的变量名看上去就像骆驼峰一样此起彼伏,既美观，又能突出由词组命名的变量，减小冲突命名的可能性。

 

4. 适时添加注释

　　有时候读代码会跟不上编程者的思维，若代码旁边没有注释，就难以理解其意思，因此适当添加注释不仅能够让自己回忆某行、某段代码的用处，还能方面阅读者理解。

　　建议在每个函数名的后面添加对该函数的功能进行解释的注释，同时建议在main函数的每一个循环也最好添加注释，让阅读者明白循环的作用。

 

以上是我阅读参考博客的读后感和建议，希望自己能够好好记住这些规范，书写优美又实用的代码。

转载于:https://www.cnblogs.com/besthunterhj/p/11455022.html