2. 程序的版式
版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。
2.1 空行
空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。
(1)在每个类声明之后、每个函数定义结束之后都要加空行。
(2)在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔
2.2 代码行
(1)一行代码只做一件事情,如只定义一个变量,或只写一条语句
(2)if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}
(3)尽可能在定义变量的同时初始化该变量(就近原则)
2.3 代码行内的空格
(1)关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while 等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。
(2)函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别
(3)‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格
(4),’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格
(5)赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。
(6)一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。
(7)象“[]”、“.”、“->”这类操作符前后不加空格
(8)对于表达式比较长的for 语句和if 语句,为了紧凑起见可以适当地去掉一些空格
2.4 对齐
(1)程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐
(2){ }之内的代码块在‘{’右边数格处左对齐
2.5 长行拆分
(1)代码行最大长度宜控制在70 至80 个字符以内
(2)长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读
2.6 修饰符的位置
(1)应当将修饰符 * 和& 紧靠变量名,如int *x, y; // 此处y 不会被误解为指针
2.7 注释
(1)版本、版权声明;
(2)函数接口说明;
(3)重要的代码行或段落提示
2.8 类的版式
类可以将数据和函数封装在一起,其中函数表示了类的行为(或称服务)。类的版式主要有两种方式:
(1)将private 类型的数据写在前面,而将public 类型的函数写在后面,采用这种版式的程序员主张类的设计“以数据为中心”,重点关注类的内部结构。
(2)2)将public 类型的函数写在前面,而将private 类型的数据写在后面,采用这种版式的程序员主张类的设计“以行为为中心”,重点关注的是类应该提供什么样的接口(或务)。
网友评论