### C++代码规范详解
#### 一、文件结构
**1. 文件开头注释：**
在每个源文件或头文件的开头，应包含一个注释块来标识文件的基本信息，如文件名、作者、日期等。这样的注释有助于追踪代码的来源及版本控制。
示例：
```cpp
/**
*@file prime.h
*@author 肖锋
*@date 2008-09-15
*@desc 素性测试函数库
*/
```
**2. 防止头文件重复引用：**
为了避免头文件被多次引用导致编译错误，通常会在头文件中使用预处理器指令`#ifndef`、`#define`和`#endif`来实现保护机制。这种机制也被称为“include guard”。
示例：
```cpp
#ifndef __PRIME_H__
#define __PRIME_H__
bool IsPrime(int num);
#endif // __PRIME_H__
```
这里`__PRIME_H__`是一个宏定义，用于唯一标识该头文件。
**3. 包含头文件的方式：**
对于标准库头文件（如`<iostream>`），应当使用`#include <filename>`的方式引入；而对于自定义的非标准库头文件，则使用`#include "filename"`方式。
示例：
```cpp
#include <iostream>
#include "prime.h"
```
**4. 分离声明与定义：**
为了提高模块化和可维护性，应将类和函数的声明放置在头文件（`.h`）中，而具体的实现则放在对应的源文件（`.cpp`）中。
示例：
```cpp
// prime.h
#ifndef __PRIME_H__
#define __PRIME_H__
bool IsPrime(int num);
#endif // __PRIME_H__
// prime.cpp
bool IsPrime(int num)
{
int i;
for (i = 2; i * i <= num; i++)
{
if (num % i == 0)
{
return false;
}
}
return true;
}
```
#### 二、排版风格
良好的代码排版可以提升代码的可读性和可维护性。以下是一些关于代码排版的具体建议：
**1. 缩进规则：**
- 使用4个空格或4字符宽的Tab进行缩进。
- 在程序块中的代码应该相应地进行缩进。
- 大括号`{}`应独占一行，并且保持对齐。
示例：
```cpp
if (a > 0)
{
cout << "a > 0" << endl;
}
else
{
cout << "a <= 0" << endl;
}
```
**2. 条件与循环语句：**
- `if`、`else`和`else if`应该对齐。
- `for`、`while`和`do while`语句中的关键字后应该有一个空格。
- `do while`语句中，`while`与程序块结束的`}`在同一行。
示例：
```cpp
do
{
cout << num << endl;
num++;
} while (num < 10);
```
**3. 分支语句：**
- `switch`语句中的所有`case`应对其对齐。
- 每个`case`后跟一个语句块，并进行相应的缩进。
- 最后添加一个`default`分支以处理未匹配的情况。
示例：
```cpp
switch (op)
{
case 0:
c = a + b;
break;
case 1:
c = a - b;
break;
default:
c = 0;
break;
}
```
**4. 空行分隔：**
- 函数、类、结构体等独立程序块之间应以空行分隔。
- 同一个程序块内的逻辑相关语句之间不加空行；不相关的语句间则应以空行分隔。
示例：
```cpp
struct Node
{
int x;
};
// 空行
void Function()
{
}
// 空行
int main()
{
return 0;
}
```
**5. 空格使用：**
- 逗号（`,`）后要留空格。
- 分号（`;`）后也要留空格。
- 单目运算符（如`++`、`--`）前不加空格。
- 双目和三目操作符前后需要加空格。
- 关键字（如`if`、`for`、`while`）前后需有空格。
- 函数名后紧跟左括号（`(`），不加空格。
- 单行注释（`//`）前后要加空格。
- 指针修饰符（`*`）和引用修饰符（`&`）紧跟其后的变量名，不加空格。
示例：
```cpp
int Gcd(int a, int b)
{
int i;
for (i = a; i >= 2; i--)
{
if (a % i == 0 && b % i == 0)
{
return i;
}
}
return 1;
}
```
遵循这些规范可以帮助开发者编写出更易于理解和维护的代码。在实际项目开发过程中，团队成员应当共同遵守一套统一的代码规范，以确保整个项目的代码风格一致。
