小言_互联网的博客

高质量C++/C编程指南(二)程序版式

695人阅读  评论(0)

目录

一、空行

二、代码行

三、代码行内的空行

四、对齐

五、长行拆分

六、修饰符的位置

七、注释

八、类的版式


一、空行

       空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。
[规则2-1-1]  在每个类声明之后、每个函数定义结束之后都要加空行。参见示例。
[规则2-1-2]  在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。参见示例。

函数之间的空行

//空行
void Function1 (...)
{
...
}
//空行
void Function2(..)
{
..
}
//空行
void Function3(..)
{
..
}
 

函数内部的空行

//空行
while (condition)

{
statement1;
//空行
if (condition)

{
statement2 ;
}
else

{
statement3;
}
//空行
statement4;
}

二、代码行

[规则2-2-1]   一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
[规则2-2-2]   if、for、 while、 do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

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

三、代码行内的空行

[规则2-3-1]  关键字之后要留空格。象const、virtual、 inline、 case 等关键字之后至少要留一个空格,否则无法辨析关键字。像if、for、while等关键字之后,应留一个空格再跟左括号‘(’,以突出关键字。
[规则2-3-2]  函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。
[规则2-3-3]  ‘(’向后紧跟,‘) ’、‘, ’、;’向前紧跟,紧跟处不留空格。
[规则2-3-4]  ','之后要留空格,如Function(x, y, z)。 如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)。
[规则2-3-5]  赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符, 如“=”、“+=”  “>=”  “<=”、“+” “*”、“%”、“&&”、“|”、“<<”,“”等二元操作符的前后应当加空格
[规则2-3-6]  一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格
[规则2-3-7]  像“[]”、“.”、“->”这类操作符前后不加空格
[建议2-3-8]  对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格,如for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))

四、对齐

[规则2-4-1]  程序的分界符‘{'和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
[规则2-4-2]  { }之内的代码块在‘{' 右边数格处左对齐。

五、长行拆分

[规则2-5-1]  代码行最大长度宜控制在70至80个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
[规则2-5-2]  长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

六、修饰符的位置

[规则2-6-1]  应当将修饰符*和&紧靠变量名

七、注释

[规则2-7-1]  注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少
[规则2-7-2]  如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如i++;//i加1,多余的注释
[规则2-7-3]  边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
[规则2-7-4]  注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。
[规则2-7-5]  尽量避免在注释中使用缩写,特别是不常用缩写。
[规则2-7-6]  注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方
[规则2-7-8]  当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

八、类的版式

        类可以将数据和函数封装在一起,其中函数表示了类的行为(或称服务)。类提供关键字public、protected 和private,分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的,即让类仅仅公开必须要让外界知道的内容,而隐藏其它一切内容。我们不可以滥用类的封装功能,不要把它当成火锅,什么东西都往里扔。
类的版式主要有两种方式:
(1) 将private类型的数据写在前面,而将public类型的函数写在后面,如示例8-3(a)。采用这种版式的程序员主张类的设计“以数据为中心”,重点关注类的内部结构
(2) 将public类型的函数写在前面,而将private类型的数据写在后面,如示例8.3 (b)采用这种版式的程序员主张类的设计“以行为为中心”,  重点关注的是类应该提供什么样的接口(或服务)

       很多C++教课书受到Biarne Stroustrup 第一本 著作的影响,不知不觉地采用了“以数据为中心”的书写方式,并不见得有多少道理。
       我建议读者采用“以行为为中心”的书写方式,即首先考虑类应该提供什么样的函数。这是很多人的经验&#0;&#0;“这样做不仅让自己在设计类时思路清晰,而且方便别人阅读。因为用户最关心的是接口,谁愿意先看到一堆私有数据成员!”

 


转载:https://blog.csdn.net/qq_38426928/article/details/106451265
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场