第2章 程式的版式

2008-02-23 05:28:53来源:互联网 阅读 ()

新老客户大回馈,云服务器低至5折

版式虽然不会影响程式的功能,但会影响可读性。程式的版式追求清楚、美观,是程式风格的重要构成因素。</P><P>能够把程式的版式比喻为“书法”。好的“书法”可让人对程式一目了然,看得兴致勃勃。差的程式“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程式员们学习程式的“书法”,弥补大学电脑教育的漏矗?翟诤苡斜匾??lt;/P><P>2.1 空行空行起着分隔程式段落的作用。空行得体(但是多也但是少)将使程式的布局更加清楚。空行不会浪费内存,虽然打印含有空行的程式是会多消耗一些纸张,但是值得。所以不要舍不得用空行。</P><P>【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例2-1(a)</P><P>【规则2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其他地方应加空行分隔。

参见示例2-1(b )</P><P>示例2-1(b) 函数内部的空行
/// 空行
void Function1(…)
{

}
// 空行
void Function2(…)
{

}
// 空行
void Function3(…)
{

}

示例2-1(b) 函数内部的空行
/ 空行
while (condition)
{
statement1;
// 空行</P><P> if (condition)
{
statement2;
}
else
{
statement3;
}
// 空行
statement4;
} </P><P> </P><P>2.2 代码行
l

【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。</P><P>l

【规则2-2-2】if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样能够防止书写失误。
示例2-2(a)为风格良好的代码行,示例2-2(b)为风格不良的代码行。</P><P>示例2-2(a) 风格良好的代码行
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();</P><P>示例2-2(b) 风格不良的代码行
int width, height, depth; // 宽度高度深度
X = a b; y = c d; z = e f;
if (width < height) dosomething();
for (initialization; condition; update)
dosomething();
other();

【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)假如变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。假如引用了未被初始化的变量,可能会导致程式错误。本建议能够减少隐患。例如
int width = 10; // 定义并初绐化width
int height = 10; // 定义并初绐化height
int depth = 10; // 定义并初绐化depth </P><P>2.3 代码行内的空格
【规则2-3-1】关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。</P><P>

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

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

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

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

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

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

【建议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();</P><P>示例2-3 代码行内的空格</P><P>2.4 对齐
【规则2-4-1】程式的分界符‘{’和‘}’应独占一行并且位于同一列,同时和引用他们的语句左对齐。</P><P>

【规则2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。示例2-4(a)为风格良好的对齐,示例2-4(b)为风格不良的对齐。</P><P>示例2-4(a) 风格良好的对齐
void Function(int x)
{

标签:

版权申明:本站文章部分自网络,如有侵权,请联系:west999com@outlook.com
特别注意:本站所有转载文章言论不代表本站观点,本站所提供的摄影照片,插画,设计作品,如需使用,请与原作者联系,版权归原作者所有

上一篇: 第1章 文档结构

下一篇: 第3章 命名规则