CC++编程规范.docx

1. 文件结构
每个C++/C 程序通常分为两个文件。一个文件用于保存程序的声明(declaration),
称为头文件。另一个文件用于保存程序的实现( implementation),称为定义( definition)
C++/C 程序的头文件以“.h”为后缀,C 程序的定义文件以“. c”为后缀,C++程序
的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。
版权和版本的声明
版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有:
(1)版权信息
(2)文件名称,标识符,摘要
(3)当前版本号,作者/修改者,完成日期
(4)版本历史信息
示例 1-1 版权和版本的声明
版本标识:采用<主版本号>.<次版本号>.<修订号> 来命名自己产品的编号。Linux 核心还有一个约定,
就是如果次版本号是偶数(如0、2、4 等),代表正式版本,如果次版本号是奇数(如1、3、5 等),代
表的是开发过程中的测试版本。修订号则相当于 Build 号,用来标识一些小的改动。
头文件的结构
头文件由三部分内容组成:
1)头文件开头处的版权和版本声明(参见示例1-1)。
2)预处理块。
/*
* Copyright (c) 2003,北京梅梅出品有限公司
* All rights reserved.
*
* 文件名称:
* 文件标识:见配置管理计划书
* 摘要:简要描述本文件的内容
*/
#ifndef GRAPHICS_H // 被重复引用
#define GRAPHICS_H
下面其它的声明代码
………
下面是原作者、版本、完成、日期和当前版本的信息
/* 当前版本:
* 作者:输入作者(或修改者)名字
* 完成日期:2003年5月20日
*
* 取代版本:
* 原作者:输入原作者(或修改者)名字
* 完成日期:2003年4月10日
*/
编程规范系列

// 版权和版本声明见示例1-1,此处省略。
#ifndef GRAPHICS_H // 被重复引用
#define GRAPHICS_H
#include <> // 引用标准库的头文件
…
#include “”// 引用非标准库的头文件
…
void Function1(…); // 全局函数声明
…
class Box // 类结构声明
{ …
};
#endif
// 版权和版本声明见示例1-1,此处省略。
#include “”// 引用头文件
…
// 全局函数的实现体
void Function1(…)
{
...
}
// 类成员函数的实现体
void Box::Draw(...)
{
...
}
3)函数和类结构声明等。
,头文件的结构参见示例1-2。
【规则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 C++/C 头文件的结构
定义文件的结构
定义文件有三部分内容:
1) 定义文件开头处的版权和版本声明(参见示例1-1)。
2) 对一些头文件的引用。
3) 程序的实现体(包括数据和代码)。
,定义文件的结构参见示例1-3
编程规范系列

示例1-3 C++/C 定义文件的结构
目录结构
如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的
目录,以便于维护。
例如可将头文件保存于include 目录,将定义文件保存于source 目录(可以是多级目录)。
如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强
信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。
2. 程序版式
2