2007年3月22日木曜日

高质量C++/C编程指南 -- 第2章 程序的版式

[ 永远的UNIX::UNIX技术资料的宝库 ]

首页 > 编程技术 > C/C++ > 正文

高质量C++/C编程指南 -- 第2章 程序的版式

来源:本文出自: 作者: 林锐 博士 (2002-07-12 06:02:00)

2 程序的版式

版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。

可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。

2.1 空行

空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。

l 【规则2-1-1在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1a

l 【规则2-1-2在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。参见示例2-1b

// 空行

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-2ifforwhiledo等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

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

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 <>

{

dosomething();

}

if (width <>

for (initialization; condition; update)

{

dosomething();

}

// 空行

other();

for (initialization; condition; update)

dosomething();

other();

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

² 【建议2-2-1尽可能在定义变量的同时初始化该变量(就近原则)

如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。例如

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

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

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

2.3 代码行内的空格

l 【规则2-3-1关键字之后要留空格。象constvirtualinlinecase 等关键字之后至少要留一个空格,否则无法辨析关键字。象ifforwhile等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。

l 【规则2-3-2函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。

l 【规则2-3-3‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

l 【规则2-3-4‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)

l 【规则2-3-5赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+= >=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<,^”等二元操作符的前后应当加空格。

l 【规则2-3-6一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。

l 【规则2-3-7象“[]”、“.”、“->”这类操作符前后不加空格。

² 【建议2-3-1对于表达式比较长的for

0 件のコメント: