成品检验作业指导书.doc

软件编程手册
编写:
校对:
审核:
日期:
目录
1. 文件结构 3
版权和版本的声明 3
头文件的结构 4
定义文件的结构 4
目录结构 4
2. 程序版式 5
空行 5
代码行 5
代码行内的空格 5
对齐 6
长行拆分 6
修饰符的位置 6
注释 6
类的版式 7
3 命名规则 8
共性规则 8
Windows 应用程序命名规则 8
4. 表达式和基本语句 9
运算符的优先级 9
复合表达式 9
if 语句 9
循环语句的效率 10
for 语句的循环控制变量 10
5. 常量 10
const 与#define 的比较 11
常量定义规则 11
6. 函数设计 11
参数的规则 11
返回值的规则 12
函数内部实现的规则 12
其它建议 13
使用断言 13
引用与指针的比较 14
7 重载和内联 14
普通函数重载 14
成员函数的重载、覆盖与隐藏 15
内联函数 15
8. 内存管理 15
9 类的构造函数、析构函数、成员函数与赋值函数 16
类的构造函数 16
成员函数 16
10. 类的继承和组合 16
11. 其他规范及建议 17
提高程序的效率 17
一些有益的建议 17
1. 文件结构
每个C++/C 程序通常分为两个文件。一个文件用于保存程序的声明,称为头文件。另一个文件用于保存程序的实现,称为定义C++/C 程序的头文件以“.h”为后缀,C 程序的定义文件以“. c”为后缀,C++程序的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。
版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头,主要内容有:
(1)版权信息
(2)文件名称,标识符,摘要
(3)当前版本号,作者/修改者,完成日期
(4)版本历史信息
版本标识:采用<主版本号>.<次版本号>.<修订号> 来命名自己产品的编号。
头文件的结构
头文件由三部分内容组成:
1)头文件开头处的版权和版本声明。
2)预处理块。
3)函数和类结构声明等。
【规则1-2-1】为了防止头文件被重复引用,应当用ifndef/define/endif 结构产生预处理块。
【规则1-2-2】用#include < > 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。
【规则1-2-3】用#include “”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。
【建议1-2-1】头文件中只存放“声明”而不存放“定义”
【建议1-2-2】不提倡使用全局变量,尽量不要在头文件中出现象extern int value 这类声明。
定义文件的结构
定义文件有三部分内容:
1) 定义文件开头处的版权和版本声明。
2) 对一些头文件的引用。
3) 程序的实现体(包括数据和代码)。
目录结构
如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。例如可将头文件保存于include 目录,将定义文件保存于source 目录(可以是多级目录)。如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。
2. 程序版式
空行
空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,所以不要舍不得用空行。
【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。
【规则2-1-2】在一个函数体内,逻辑上密切相关的语句之间不加空行,其它地方应加空行分隔。
代码行
【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
【规则2-2-2】if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)。
代码行内的空格
【规则2-3-1】关键字之后要留空格。像const、virtual、inline、case 等关键字