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

目录

一、空行

二、代码行

三、代码行内的空行

四、对齐

五、长行拆分

六、修饰符的位置

七、注释

八、类的版式


一、空行

       空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。
[规则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;“这样做不仅让自己在设计类时思路清晰,而且方便别人阅读。因为用户最关心的是接口,谁愿意先看到一堆私有数据成员!”

 

已标记关键词 清除标记
目 录 前 言6 第1 章 文件结构 1.1 版权和版本的声明. 1.2 头文件的结构. 1.3 定义文件的结构. 1.4 头文件的作用. 1.5 目录结构. 第2 章 程序版式 2.1 空行. 2.2 代码行. 2.3 代码行内的空格. 2.4 对齐. 2.5 长行拆分. 2.6 修饰符的位置. 2.7 注释. 2.8 类的版式. 第3 章 命名规则 3.1 共性规则. 3.2 简单的WINDOWS 应用程序命名规则. 3.3 简单的UNIX 应用程序命名规则 第4 章 表达式和基本语句 4.1 运算符的优先级. 4.2 复合表达式. 4.3 IF 语句 4.4 循环语句的效率. 4.5 FOR 语句的循环控制变量. 4.6 SWITCH 语句. 4.7 GOTO 语句. 第5 章 常量 5.1 为什么需要常量. 5.2 CONST 与 #DEFINE 的比较. 5.3 常量定义规则. 5.4 类中的常量. 第6 章 函数设计 高质量C++/C 编程指南,v 1.0 2001 Page 4 of 101 6.1 参数的规则. 6.2 返回值的规则. 6.3 函数内部实现的规则. 6.4 其它建议. 6.5 使用断言. 6.6 引用与指针的比较. 第7 章 内存管理 7.1 内存分配方式 7.2 常见的内存错误及其对策 7.3 指针与数组的对比 7.4 指针参数是如何传递内存的? 7.5 FREE 和DELETE 把指针怎么啦? 7.6 动态内存会被自动释放吗?. 7.7 杜绝“野指针”. 7.8 有了MALLOC/FREE 为什么还要NEW/DELETE ?. 7.9 内存耗尽怎么办?. 7.10 MALLOC/FREE 的使用要点 7.11 NEW/DELETE 的使用要点. 7.12 一些心得体会 第8 章 C++函数的高级特性 8.1 函数重载的概念. 8.2 成员函数的重载、覆盖与隐藏. 8.3 参数的缺省值. 8.4 运算符重载. 8.5 函数内联. 8.6 一些心得体会. 第9 章 类的构造函数、析构函数与赋值函数 9.1 构造函数与析构函数的起源. 9.2 构造函数的初始化表. 9.3 构造和析构的次序. 9.4 示例:类STRING 的构造函数与析构函数 9.5 不要轻视拷贝构造函数与赋值函数. 9.6 示例:类STRING 的拷贝构造函数与赋值函数 9.7 偷懒的办法处理拷贝构造函数与赋值函数. 9.8 如何在派生类中实现类的基本函数. 9.9 一些心得体会. 第10 章 类的继承与组合. 高质量C++/C 编程指南,v 1.0 2001 Page 5 of 101 10.1 继承 10.2 组合 第11 章 其它编程经验. 11.1 使用CONST 提高函数的健壮性 11.2 提高程序的效率 11.3 一些有益的建议 参考文献 附录A :C++/C 代码审查表. 附录B :C++/C 试题. 附录CC++/C 试题的答案与评分标准.
林锐 博士 CHM电子书 目 录 前 言 6 第1章 文件结构 11 1.1 版权和版本的声明 11 1.2 头文件的结构 12 1.3 定义文件的结构 13 1.4 头文件的作用 13 1.5 目录结构 14 第2章 程序版式 15 2.1 空行 15 2.2 代码行 16 2.3 代码行内的空格 17 2.4 对齐 18 2.5 长行拆分 19 2.6 修饰符的位置 19 2.7 注释 20 2.8 类的版式 21 第3章 命名规则 22 3.1 共性规则 22 3.2 简单的WINDOWS应用程序命名规则 23 3.3 简单的UNIX应用程序命名规则 25 第4章 表达式和基本语句 26 4.1 运算符的优先级 26 4.2 复合表达式 27 4.3 IF 语句 27 4.4 循环语句的效率 29 4.5 FOR 语句的循环控制变量 30 4.6 SWITCH语句 30 4.7 GOTO语句 31 第5章 常量 33 5.1 为什么需要常量 33 5.2 CONST 与 #DEFINE的比较 33 5.3 常量定义规则 33 5.4 类中的常量 34 第6章 函数设计 36 6.1 参数的规则 36 6.2 返回值的规则 37 6.3 函数内部实现的规则 39 6.4 其它建议 40 6.5 使用断言 41 6.6 引用与指针的比较 42 第7章 内存管理 44 7.1内存分配方式 44 7.2常见的内存错误及其对策 44 7.3指针与数组的对比 45 7.4指针参数是如何传递内存的? 47 7.5 FREE和DELETE把指针怎么啦? 50 7.6 动态内存会被自动释放吗? 50 7.7 杜绝“野指针” 51 7.8 有了MALLOC/FREE为什么还要NEW/DELETE ? 52 7.9 内存耗尽怎么办? 53 7.10 MALLOC/FREE 的使用要点 54 7.11 NEW/DELETE 的使用要点 55 7.12 一些心得体会 56 第8章 C++函数的高级特性 57 8.1 函数重载的概念 57 8.2 成员函数的重载、覆盖与隐藏 60 8.3 参数的缺省值 63 8.4 运算符重载 64 8.5 函数内联 65 8.6 一些心得体会 68 第9章 类的构造函数、析构函数与赋值函数 69 9.1 构造函数与析构函数的起源 69 9.2 构造函数的初始化表 70 9.3 构造和析构的次序 72 9.4 示例:类STRING的构造函数与析构函数 72 9.5 不要轻视拷贝构造函数与赋值函数 73 9.6 示例:类STRING的拷贝构造函数与赋值函数 73 9.7 偷懒的办法处理拷贝构造函数与赋值函数 75 9.8 如何在派生类中实现类的基本函数 75 9.9 一些心得体会 77 第10章 类的继承与组合 78 10.1 继承 78 10.2 组合 80 第11章 其它编程经验 82 11.1 使用CONST提高函数的健壮性 82 11.2 提高程序的效率 84 11.3 一些有益的建议 85 参考文献 87 附录A :C++/C代码审查表 88 附录B :C++/C试题 93 附录CC++/C试题的答案与评分标准 97
相关推荐
内容简介回到顶部↑高质量软件开发是国内计算机教育的薄弱环节,很多程序员虽然能熟练地掌握编程技术但是缺乏强烈的质量意识,不懂得在开发过程中内建高质量。这使得大部分企业只能依靠大量地测试和改错来提高软件产品的质量,为此付出了高昂的代价。因此,如何有效地提高软件产品的质量是IT企业面临的主要挑战之一。 本书论述高质量软件开发方法与C++/C编程规范共十五章,分两部分: 第一部分共四章,重点介绍软件质量和面向对象程序设计方法。 第部分共十一章,重点阐述C++/C编程风格和一些技术专题。 本书以幽默的笔调对软件工程和编程作了很好的论述。前期版本曾经在Internet上广泛流传,被国内IT企业的不少软件开发人员采用。 本书的主要读者对象是IT企业的程序员和项目经理,以及高年级本科生和研究生。 目录回到顶部↑第一部分 综述 第1章 高质量软件开发之道 第2章 做好程序员 第3章 编程语言发展简史 第4章 面向对象程序设计方法概述 第部分 C++/C编程规范 第5章 文件结构 第6章 程序版式 第7章 命名规则 第8章 表达式与基本语句 第9章 常量 第10章 函数设计 第11章 内存管理 第12章 C++函数的高级特性 第13章 类的构造函数、析构函数与赋值函数 第14章 C++ STL应用 第15章 其它编程经验 参考文献及评注 第三部分 附录 附录 A:C++/C 试题
<p> <b><span style="background-color:#FFE500;">【超实用课程内容】</span></b> </p> <p> <br /> </p> <p> <br /> </p> <p> 本课程内容包含讲解<span>解读Nginx的基础知识,</span><span>解读Nginx的核心知识、带领学员进行</span>高并发环境下的Nginx性能优化实战,让学生能够快速将所学融合到企业应用中。 </p> <p> <br /> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <b><br /> </b> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <b><span style="background-color:#FFE500;">【课程如何观看?】</span></b> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> PC端:<a href="https://edu.csdn.net/course/detail/26277"><span id="__kindeditor_bookmark_start_21__"></span></a><a href="https://edu.csdn.net/course/detail/27216">https://edu.csdn.net/course/detail/27216</a> </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 移动端:CSDN 学院APP(注意不是CSDN APP哦) </p> <p style="font-family:Helvetica;color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 本课程为录播课,课程永久有效观看时长,大家可以抓紧时间学习后一起讨论哦~ </p> <p style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <br /> </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <strong><span style="background-color:#FFE500;">【学员专享增值服务】</span></strong> </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> <b>源码开放</b> </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 课件、课程案例代码完全开放给你,你可以根据所学知识,自行修改、优化 </p> <p class="ql-long-24357476" style="font-family:"color:#3A4151;font-size:14px;background-color:#FFFFFF;"> 下载方式:电脑登录<a href="https://edu.csdn.net/course/detail/26277"></a><a href="https://edu.csdn.net/course/detail/27216">https://edu.csdn.net/course/detail/27216</a>,播放页面右侧点击课件进行资料打包下载 </p> <p> <br /> </p> <p> <br /> </p> <p> <br /> </p>
©️2020 CSDN 皮肤主题: 深蓝海洋 设计师:CSDN官方博客 返回首页