C++代码风格与编程习惯

代码风格

代码风格（包括注释风格）其实无碍于我们编写出优秀的程序，然而为了提高代码可读性，我们有必要遵循一些风格，并且一旦确定好了就坚持使用。当然，请记住风格是不唯一的。以下仅仅是博主建议采用的风格。

代码风格

1、函数名与紧跟着的圆括号之间不添加任何符号，包括空格、回车、制表。

int foo();//foo与()间不添加任何空白符

2、函数体的左右花括号独占一行。

int main()
{
	...
}

3、相对于制约它的最内层的花括号对，每一行代码都进行缩进。
4、复合IO表达式，进行恰当缩进，使得"<<“或者”>>"整齐排列。

#include <iostream>

using namespace std;

int main()
{
	cout << "Hello World!"
		<< "Hello World!"
		<< "Hello World!"
	return 0;
}

5、当然，可以借助IDE的格式化代码快捷键功能。如VS2019中，ctrl+K后ctrl+F，可以快速格式化代码。
6、当我们有需要连续定义声明同一种类型的多个变量时，每一条声明语句仅定义声明一个变量，且独占一行。当你可能需要为每一个变量都添加注释时，这样写就有好处了。

int main()
{
    int a;
    int b;
    int c;
    /*
	*尽量避免以下的声明方式：
	*int a,b,c;
	*或者
	*int a;int b;int c;
	*/
    return 0;
}

7、标识符命名规范：
①一般变量名使用小写字母，如：int sum;
②变量名尽量使用有含义的英文单词，尽量避免使用拼音单词。
③当变量名需要多个单词，可采用以下两种方式之一：

int sumOfNumbers;//第一个单词小写，后续单词首字母大写

或者

int sum_numbers;//所有单词小写，使用下划线_分隔开

博主习惯使用第二种。

④常量名使用全大写字母，如：const double PI = 3.1415;
⑤自定义的类名，首字母大写，如：class Car;

以下是我在《C++ Primer 第5版中文版》中看到的一些规则：

1、用户自定义的标识符不能连续出现2个下划线
2、不能下划线紧跟大写字母开头
3、定义在函数体外的标识符不能以下划线开头

这3条规则在书中上下文看来似乎是标识符的文法规则，但博主在读此书前并未听闻，且在VS中也能编译通过，因此暂时归纳在这个地方，大家了解一下即可。

注释风格

C++的注释有两种，一种为单行注释（使用双斜杠//），另一种为多行注释（使用一组斜杠和星号/* */）。

1、单行注释：单行注释也分为半行注释、整行注释。
半行注释：注释与代码在同一行。

int main()
{
    cout << "Hello World!";//半行注释，打印hello world字符串
    return 0;
}

整行注释：注释在上一行，被注释的代码在下一行。

int main()
{
	//整行注释，打印hello world字符串
    cout << "Hello World!";
    return 0;
}

2、多行注释：注释内的每一行都以一个星号*开头，指出整个范围都是多行注释的一部分。

#include <iostream>

using namespace std;
/*
*主函数作用：
*打印Hello World字符串
*/
int main()
{
    cout << "Hello World!";
    return 0;
}

3、切忌注释嵌套。特别地，当多行注释嵌套时还可能会引起编译错误。
4、基于第3点，当我们要注释一大片代码时，在每一行的代码前使用单行注释， 而避免使用多行注释。

int main()
{
    //cout << "Hello World!";
    //cout << "Hello World!";
    //cout << "Hello World!";
    //cout << "Hello World!";
    //cout << "Hello World!";
    cout << "Hello World!";
    return 0;
}

5、当然，可以借助IDE的注释快捷键功能。如VS2019中，ctrl+K后ctrl+C，可以帮助你注释选定行，且相当智能地能避免多行注释嵌套。

编程习惯

1、当你每次编写程序时，起手必写上using namespace xxx语句，那么我认为你已经完全理解namespace的相关概念知识。但如果你还不清楚，那么切勿养成滥用的习惯。

使用using namespace语句实质是一种强行打破命名空间的行为，使得xxx命名空间完全开放。当你在为一个大型工程效力时，且该工程与多个命名空间有联系的时候，这一点可能就需要注意了。

有一个更稳妥的办法是using命名空间中指定的内容，如下：

#include <iostream>

//using namespace std;
using std::cout;

int main()
{
    cout << "Hello World!";
    return 0;
}

当然，如果你很清楚你的程序不会因为namespace产生问题时，请放心书写using namespace xxx语句。毕竟繁琐地书写诸如 using std::out 或者 std::cout 的代码都比较麻烦。简洁的代码带来的是高效的开发效率。

2、绝大部分情况下，形参可以尽量使用引用，这对执行效率的提高是有益的。

void foo(int& ex);

但如果你不想因函数的调用使实参莫名受到修改，请使用常引用。

void foo(const int& ex);

3、当进行debug时，请从第一个bug开始按顺序修复。

因为有可能当你修复了第一个bug时，后面的错误就自然消失了，其原因涉及编译原理的知识。博主非常建议，主攻C++方向的计算机相关专业的在校大学生，选修《编译原理》这一门课程。

4、仅在某个变量需要准备首次用到时，才去定义声明该变量，而不要程序开头就堆砌一大团变量的定义声明语句。

这个编程习惯其实比较受争议，因为有利有弊。利：对于程序的执行效率的提高是有益的，不过这个提高可能对复杂的大型程序才明显一点。弊：难以对程序所用的所有变量一目了然。

5、对内置类型的变量，在定义时都进行显示地初始化。

…未完待续，长期更新