代码规范是每个程序员倍加关注的问题。C语言编码与注释规范，懂不懂编码规范笔试时能一眼被看出来，有良好的编码习惯笔试时也会增色不少，知道你有过工作经验或者参与过大型项目。本文是在学习林锐博士的《高质量C/C++编程指南》一书中，摘录、总结的笔记。
文章目录
- 1 文件结构
- 1.1 版权和版本的声明
- 1.2 头文件的结构
- 1.4 头文件的作用
- 1.5 目录结构
- 2 程序的版式
- 2.1 空行
- 2.2 代码行
- 2.3 代码行内的空格
- 2.4 对齐
- 2.5 长行拆分
- 2.6 修饰符的位置
- 2.7 注释
- 3 命名规则
- 3.1 共性规则
- 3.2 简单的Windows应用程序命名规则
1 文件结构
每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。
C++/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C++程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。
1.1 版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头，主要内容有：
（1）版权信息。
（2）文件名称，标识符，摘要。
（3）当前版本号，作者/修改者，完成日期。
（4）版本历史信息。
1.2 头文件的结构
头文件由三部分内容组成：
（1）头文件开头处的版权和版本声明。
（2）预处理块。
（3）函数和类结构声明等。
假设头文件名称为 graphics.h，头文件的结构参见示例1-2。
【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。
【规则1-2-2】用 #include <filename.h>格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。
【规则1-2-3】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。
【建议1-2-1】头文件中只存放“声明”而不存放“定义”。
在C++ 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小。
【建议1-2-2】不提倡使用全局变量，尽量不要在头文件中出现象extern int value这类声明。
#ifndef GRAPHICS_H // 防止graphics.h被重复引用
#define GRAPHICS_H
#include <math.h> // 引用标准库的头文件
…
#include "myheader.h" // 引用非标准库的头文件
…
void Function1(…); // 全局函数声明
…
class Box // 类结构声明
{
…
};
#endif
1.3 定义文件的结构
定义文件有三部分内容：
（1） 定义文件开头处的版权和版本声明（参见示例1-1）。
（2） 对一些头文件的引用。
（3） 程序的实现体（包括数据和代码）。
假设定义文件的名称为graphics.cpp，定义文件的结构参见示例1-3
// 版权和版本声明见示例1-1，此处省略。
#include "graphics.h" // 引用头文件
…
// 全局函数的实现体
void Function1(…)
{
…
}
// 类成员函数的实现体
void Box::Draw(…)
{
…
}
1.4 头文件的作用
早期的编程语言如Basic、Fortran没有头文件的概念，C++/C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：
（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。
（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。
1.5 目录结构
如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。
例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。
如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。
2 程序的版式
版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。
可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。
2.1 空行
空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。
【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。
// 空行
void Function1(…)
{
…
}
// 空行
void Function2(…)
{
…
}
// 空行
void Function3(…)
{
…
}
【规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。
// 空行
while (condition)
{
statement1;
// 空行
if (condition)
{
statement2;
}
else
{
statement3;
}
// 空行
statement4;
}
2.2 代码行
【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
【规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
风格良好的代码行
int width; // 宽度
int height; // 高度
int depth; // 深度
x = a + b;
y = c + d;
z = e + f;
if (width < height)
{
dosomething();
}
for (initialization; condition; update)
{
dosomething();
}
// 空行
other();
风格不良的代码行(是不是和自己写的代码异常相似)
int width, height, depth; // 宽度高度深度
x ＝ a + b; y = c + d; z = e + f;
if (width < height) dosomething();
for (initialization; condition; update)
dosomething();
other();
2.3 代码行内的空格
【规则2-3-1】关键字之后要留空格。像const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像if、for、while等关键字之后应留一个空格再跟左括号(，以突出关键字。
【规则2-3-2】函数名之后不要留空格，紧跟左括号(，以与关键字区别。
【规则2-3-3】(向后紧跟，)、,、;向前紧跟，紧跟处不留空格。如：Function(x, y, z)和for (initialization; condition; update)注意此处：;前都没有空格，)也是。不良的分格如：Function( x, y, z )或者for ( initialization; condition; update )。
【规则2-3-4】‘,’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。
【规则2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如=、+=、>=、<=、+、*、%、&&、||、<<,^等二元操作符的前后应当加空格。
【规则2-3-6】一元操作符如!、~、++、--、&（地址运算符）等前后不加空格。
【规则2-3-7】像[]、.、->这类操作符前后不加空格。
【建议2-3-1】对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如
for (i=0; i<10; i++)
以及
if ((a<=b) && (c<=d))
void Func1(int x, int y, int z); // 良好的风格
void Func1 (int x,int y,int z); // 不良的风格
if (year >= 2000) // 良好的风格
if(year>=2000) // 不良的风格
if ((a>=b) && (c<=d)) // 良好的风格
if(a>=b&&c<=d) // 不良的风格
for (i=0; i<10; i++) // 良好的风格
for(i=0;i<10;i++) // 不良的风格
for (i = 0; i < 10; i ++) // 过多的空格
x = a < b ? a : b; // 良好的风格
x=a<b?a:b; // 不好的风格
int *x = &y; // 良好的风格
int * x = & y; // 不良的风格
array[5] = 0; // 不要写成 array [ 5 ] = 0;
a.Function(); // 不要写成 a . Function();
b->Function(); // 不要写成 b -> Function();
2.4 对齐
【规则2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。
【规则2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。
void Function(int x)
{
… // program code
}
if (condition)
{
… // program code
}
else
{
… // program code
}
for (initialization; condition; update)
{
… // program code
}
While (condition)
{
… // program code
}
如果出现嵌套的{}，则使用缩进对齐，如：
{
…
{
…
}
…
}
2.5 长行拆分
【规则2-5-1】代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。
【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。
if ((very_longer_variable1 >= very_longer_variable12)
&& (very_longer_variable3 <= very_longer_variable14)
&& (very_longer_variable5 <= very_longer_variable16))
{
dosomething();
}
virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix,
CMatrix rightMatrix);
for (very_longer_initialization;
very_longer_condition;
very_longer_update)
{
dosomething();
}
2.6 修饰符的位置
修饰符 *和＆ 应该靠近数据类型还是该靠近变量名，是个有争议的活题。
若将修饰符 *靠近数据类型，例如：int* x; 从语义上讲此写法比较直观，即x是int类型的指针。上述写法的弊端是容易引起误解，例如：int* x, y; 此处y容易被误解为指针变量。
【规则2-6-1】应当将修饰符 * 和 ＆ 紧靠变量名
例如：
char *name;
int *x, y; // 此处y不会被误解为指针
2.7 注释
C语言的注释符为“”。而在C++语言中，程序块的注释常采用“”，行注释一般采用“//…”。注释通常用于：
（1）版本、版权声明；
（2）函数接口说明；
（3）重要的代码行或段落提示。
虽然注释有助于理解代码，但注意不可过多地使用注释。
【规则2-7-1】注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。
【规则2-7-2】如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。例如
i++; // i 加 1，多余的注释
【规则2-7-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
【规则2-7-4】注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。
【规则2-7-5】尽量避免在注释中使用缩写，特别是不常用缩写。
【规则2-7-6】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。
【规则2-7-8】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。
3 命名规则
没有一种命名规则可以让所有的程序员赞同，程序设计教科书一般都不指定命名规则。命名规则对软件产品而言并不是“成败悠关”的事，我们不要化太多精力试图发明世界上最好的命名规则，而应当制定一种令大多数项目成员满意的命名规则，并在项目中贯彻实施。
3.1 共性规则
共性规则是被大多数程序员采纳的，我们应当在遵循这些共性规则的前提下，再扩充特定的规则。
【规则3-1-1】标识符应当直观且可以拼读，可望文知意，不必进行“解码”。
标识符最好采用英文单词或其组合，便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂，用词应当准确。例如不要把CurrentValue写成NowValue。
【规则3-1-2】标识符的长度应当符合min-length && max-information原则。
几十年前老ANSI C规定名字不准超过6个字符，现今的C++/C不再有此限制。一般来说，长名字能更好地表达含义，所以函数名、变量名、类名长达十几个字符不足为怪。但并不代表名字越长越好：例如变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常可用作函数内的局部变量。
【规则3-1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。例如**Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild。而Unix应用程序的标识符通常采用“小写加下划线”的方式，如add_child**。别把这两类风格混在一起用。
【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。
例如：
int x, X; // 变量x 与 X 容易混淆
void foo(int x); // 函数foo 与FOO容易混淆
void FOO(float x);
【规则3-1-5】程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解。
【规则3-1-6】变量的名字应当使用“名词”或者“形容词＋名词”。
例如：
float value;
float oldValue;
float newValue;
【规则3-1-7】全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。
例如：
DrawBox(); // 全局函数
box->Draw(); // 类的成员函数
【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
例如：
int minValue;
int maxValue;
int SetValue(…);
int GetValue(…);
【建议3-1-9】尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。
3.2 简单的Windows应用程序命名规则
林锐博士对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用，比较适合于Windows应用软件的开发。类Unix也可以作为一个参考。再加上现在很多程序跨平台，所以这一套规则不止适用于Windows，甚至其他语言依然可以作为参考标准。
【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。
例如：
class Node; // 类名
class LeafNode; // 类名
void Draw(void); // 函数名
void SetValue(int value); // 函数名
-【规则3-2-2】变量和参数用小写字母开头的单词组合而成。
例如：
bool flag;
int drawMode;
- 【规则3-2-3】常量全用大写的字母，用下划线分割单词。
例如：
const int MAX = 100; //全局常量MAX
const int MAX_LENGTH = 100; //全局常量MAX_LENGTH
【规则3-2-4】静态变量加前缀s_（表示static）。
例如：
void Init(…)
{
static int s_initValue; // 静态变量
…
}
【规则3-2-5】之前的规则已经说明了应该尽量避免使用全局变量。但是如果不得已需要全局变量，则使全局变量加前缀g_（表示global）。
例如：
int g_howManyPeople; // 全局变量
int g_howMuchMoney; // 全局变量
【规则3-2-6】类的数据成员加前缀m_（表示member），这样可以避免数据成员与成员函数的参数同名。
例如：
void Object::SetValue(int width, int height)
{
m_width = width;
m_height = height;
}
【规则3-2-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头。
