标签:
第 1 章 文件结构
1.头文件由三部分内容组成:
(1)头文件开头处的版权和版本声明。
(2)预处理块。
(3)函数和类结构声明等。
规则1.为了防止头文件被重复引用,应当用 ifndef/define/endif 结构产生预处理块。
规则2.用 #include <filename.h> 格式来引用标准库的头文件(编译器将从标准库目录开始搜索) 。
规则3. #include “filename.h” 格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索) 。
建议1. 头文件中只存放“声明”而不存放“定义”。
建议2.不提倡使用全局变量, 尽量不要在头文件中出现象 extern int value 这类声明。
例如代码:
#ifndef GRAPHICS_H// 防止graphics.h 被重复引用
#define GRAPHICS_H
#include<math.h> // 引用标准库的头文件
…
#include “myheader.h” // 引用非标准库的头文件
…
void Function1(…); // 全局函数声明
…
class Box // 类结构声明
{
…
};
#endif
2.定义文件有三部分内容:
(1) 定义文件开头处的版权和版本声明。
(2) 对一些头文件的引用。
(3) 程序的实现体(包括数据和代码)。
#include “graphics.h” // 引用头文件
…
// 全局函数的实现体
void Function1(…)
{
…
}
// 类成员函数的实现体
void Box::Draw(…)
{
…
}
第 2 章 程序的版式
1. 空行:空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。
规则1.在每个类声明之后、每个函数定义结束之后都要加空行。
规则2.在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。
2.代码行:
规则1.一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
规则2.if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
建议:尽可能在定义变量的同时初始化该变量(就近原则) 如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。
3.代码行内的空格:
规则1.关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象 if、for、while 等关键字之后应留一个空格再跟左括号‘ (’ ,以突出关键字。
规则2.函数名之后不要留空格,紧跟左括号‘ (’,以与关键字区别。
规则3.‘(’向后紧跟, ‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。
规则4.‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如 for (initialization; condition; update)。
规则5.赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=” 、“+=” “>=” 、 “<=” 、“+” 、 “*” 、“%” 、 “&&” 、“||” 、 “<<”,“^”等二元操作符的前后应当加空格。
规则6.一元操作符如“!”、“~” 、 “++” 、“--” 、 “&” (地址运算符)等前后不加空格。
规则7.像“[]” 、“.” 、 “->”这类操作符前后不加空格。
建议:对于表达式比较长的for 语句和 if 语句,为了紧凑起见可以适当地去掉一些空格,如 for (i=0; i<10; i++)和 if((a<=b) && (c<=d))。
4.对齐:
规则1.程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
规则2.{ }之内的代码块在‘{’右边数格处左对齐。
5. 长行拆分 :
规则1.代码行最大长度宜控制在70 至 80 个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
规则2. 长表达式要在低优先级操作符处拆分成新行, 操作符放在新行之首 (以便突出操作符) 。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
6.修饰符的位置:
规则:应当将修饰符 * 和 & 紧靠变量名。
7. 注释:
C 语言的注释符为“/*…*/” 。C++语言中,程序块的注释常采用“/*…*/”,行注释一般采用“//…” 。注释通常用于:
(1)版本、版权声明;
(2)函数接口说明;
(3)重要的代码行或段落提示。
虽然注释有助于理解代码,但注意不可过多地使用注释。
规则1.注释是对代码的“提示” ,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。
规则2.如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如 i++; // i 加 1,多余的注释
规则3.边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
规则4.注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。
规则5.尽量避免在注释中使用缩写,特别是不常用缩写。
规则6.注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。
规则7.当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。
8.类的版式:
类可以将数据和函数封装在一起,其中函数表示了类的行为(或称服务) 。类提供关键字 public、protected 和 private,分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的,即让类仅仅公开必须要让外界知道的内容,而隐藏其它一切内容。
类的版式主要有两种方式:
(1) 将 private 类型的数据写在前面, 而将 public 类型的函数写在后面。
采用这种版式的程序员主张类的设计“以数据为中心” ,重点关注类的内部结构。
(2)将 public 类型的函数写在前面,而将 private 类型的数据写在后面。采用这种版式的程序员主张类的设计“以行为为中心” ,重点关注的是类应该提供什么样的接口(或服务)。
版权声明:本文为博主原创文章,未经博主允许不得转载。
《高质量程序设计指南C/C++语言 》 林锐,韩永泉编著 总结1
标签:
原文地址:http://blog.csdn.net/weichanjuan3/article/details/47281889