重读金典------高质量C编程指南（林锐）-------第二章 程序的板式

2.1 空行

规则1：在每个类声明之后，每个函数定义结束之后加空行。

规则2：在某个函数体内，相关的不加空行，不相关的加空行。

// 空行

void Function1(…) 

{ 

…

} 

// 空行

void Function2(…) 

{ 

…

} 

// 空行

void Function3(…) 

{ 

…

}

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

// 空行

函数

while (condition) 

{ 

statement1; 

// 空行

if (condition) 

{ 

 statement2; 

} 

else 

{ 

 statement3; 

} 

// 空行

statement4; 

} 

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

 

2.2  代码行

规则3：一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码便于阅读和方便写注释。

规则4：if  for   while   do 等语句自占一行，执行语句不得紧跟其后，不论执行语句多少，都要加{}，这样可以防止程序书写出错。

示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。

实例:

int width;  // 宽度

int height;  // 高度

int depth;  // 深度

int width, height, depth; // 宽度高度深度

实例:

x = a + b; 

y = c + d; 

z = e + f; 

X ＝a + b; y = c + d; z = e + f; 

实例:

if (width < height) 

{ 

   dosomething(); 

} 

if (width < height) 

   dosomething(); 

实例:

for (initialization; condition; update) 

{ 

    dosomething(); 

} 

// 空行

other(); 

for (initialization; condition; update) 

   dosomething(); 

other(); 

示例2-2(a) 风格良好的代码行  示例2-2(b) 风格不良的代码行

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

建议1、近可能的在初始化变量的同时初始化该变量.

尽可能在定义变量的同时初始化该变量（就近原则）

如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用

了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如

int width = 10;  // 定义并初绐化width

int height = 10;  // 定义并初绐化height

int depth = 10;  // 定义并初绐化depth

 

2.3   代码行内的空格

规则：关键字之后，留有空格。

规则：函数名之后不要留空格。紧跟左括号 ‘（’

规则：‘（’、‘）’、，；等，向前紧跟，紧跟后不留空格。

规则：， ； 后，需要留空格。

规则：赋值运算符、比较运算符、算术运算符、逻辑操作符、位域运算符，前后都需要加空格。

规则：一元操作符，！ ~ ++ – & 等，前后不加空格。

规则：像[] .  -> 等操作符，前后不加空格。

建议：对于比较长的for语句和if预警，为了紧凑起来可以适当的去掉空格。

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-3 代码行内的空格

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

 

2.4   对齐

规则：{  与 } 独占一行，同时与引用他们的的语句左对齐。

规则：{  之内 }的代码块在{ 右边数格处左对齐。

2.5   长行拆分

规则：代码行最大长度控制在70个字符以内，不要过长。

规则：如果需要拆分，应该在低优先级操作符处拆分成新行，操作符放在新行之首。

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(); 

} 

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

2.6  修饰符的位置

规则：应该将修饰符 * 与 & 紧靠变量名

比如： char  *name;

         int *x,y;

2.7  注释

注释通常用于  1） 版权与版本说明  2） 函数接口说明 3） 重要的代码行或者段落提示

规则：注释是提示，不可过多，不可喧宾夺主。

规则：如果代码简单，则不必再加注释。

规则：边写代码边加注释，代码与注释必须同步更新。没用的注释需要及时删除。

规则：注释需要准确，通俗易懂。

规则： 注释的位置可以放在代码的上方或者右方，不可放在下方。

规则：当代码比较长，有多重嵌套的时候，应该在结束处增加注释，便于阅读。

2.8  类的板式

     类可以将数据和函数封装在一起，其中函数表示了类的行为（或称服务）。类提供关键字public、protected和private，分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的，即让类仅仅公开必须要让外界知道的

内容，而隐藏其它一切内容。我们不可以滥用类的封装功能，不要把它当成火锅，什么东西都往里扔。

     建议采用“以行为为中心”的书写方式，即首先考虑类应该提供什么样的函数。 因为我们用户最关心的是接口，而不是一堆没有的私有数据。

class A 

{ 

public: 

void Func1(void); 

void Func2(void); 

…

private: 

int i, j; 

float x, y; 

…

}

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }