C++/C 编程指南
—程序的版式
第 2 章
程序的版式
版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风
格的重要构成因素。
“
”
“
”
可以把程序的版式比喻为 书法 。好的 书法 可让人对程序一目了然,看得兴致勃勃。差
“
”
的程序 书法 如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程
“
”
序的 书法 ,弥补大学计算机教育的漏洞,实在很有必要。
2.1
空行
空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。
空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要
舍不得用空行。
l
【规则 2-1-1】
在每个类声明之后、每个函数定义结束之后都要加空行。参见示例 2-1
( a
)
l
【规则 2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空
行分隔。参见示例 2-1
( b )
// 空行
void Function1(…)
{
…
}
// 空行
void Function2(…)
{
…
}
// 空行
void Function3(…)
{
…
}
// 空行
while (condition)
{
statement1;
// 空行
if (condition)
{
statement2;
}
else
{
statement3;
}
// 空行
statement4;
}
示例 2-1(a)
函数之间的空行 示例 2-1(b) 函数内部的空行
2.2
代码行
l
【规则 2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代
码容易阅读,并且方便于写注释。
l
【规则 2-2-2】if
、for
、while
、do 等语句自占一行,执行语句不得紧跟其后。不论执行语
句有多少都要加 {}
。这样可以防止书写失误。
示例 2-2
( a
)为风格良好的代码行,示例 2-2
( b )为风格不良的代码行。
int width; // 宽度
int height; // 高度
int depth; // 深度
int width, height, depth; // 宽度高度深度