C++编程规范---第1章 文件结构

转载 2006年06月10日 08:50:00

每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明(declaration),称为头文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。

C++/C程序的头文件以“.h”为后缀,C程序的定义文件以“.c”为后缀,C++程序的定义文件通常以“.cpp”为后缀(也有一些系统以“.cc”或“.cxx”为后缀)。

1.1 版权和版本的声明

版权和版本的声明位于头文件和定义文件的开头(参见示例1-1),主要内容有:

1)版权信息。

2)文件名称,标识符,摘要。

3)当前版本号,作者/修改者,完成日期。

4)版本历史信息。

 

/*

* Copyright (c) 2001,上海贝尔有限公司网络应用事业部

* All rights reserved.

*

* 文件名称:filename.h

* 文件标识:见配置管理计划书

*     要:简要描述本文件的内容

*

* 当前版本:1.1

*     者:输入作者(或修改者)名字

* 完成日期:2001720

*

* 取代版本1.0

* 原作者  输入原作者(或修改者)名字

* 完成日期:2001510

*/

 

示例1-1 版权和版本的声明

1.2 头文件的结构

头文件由三部分内容组成:

1)头文件开头处的版权和版本声明(参见示例1-1)。

2)预处理块。

3)函数和类结构声明等。

假设头文件名称为 graphics.h,头文件的结构参见示例1-2

 

l         【规则1-2-1为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。

l         【规则1-2-2 #include <filename.h> 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。

l         【规则1-2-3 #include “filename.h” 格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。

²        【建议1-2-1头文件中只存放“声明”而不存放“定义”

C++ 语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。建议将成员函数的定义与声明分开,不论该函数体有多么小。

²        【建议1-2-2不提倡使用全局变量,尽量不要在头文件中出现象extern int value 这类声明。

 

// 版权和版本声明见示例1-1,此处省略。

 

#ifndef   GRAPHICS_H  // 防止graphics.h被重复引用

#define   GRAPHICS_H

 

#include <math.h>     // 引用标准库的头文件

#include “myheader.h”   // 引用非标准库的头文件

void Function1(…);   // 全局函数声明

class Box             // 类结构声明

{

};

#endif

示例1-2 C++/C头文件的结构

 

1.3 定义文件的结构

定义文件有三部分内容:

(1)       定义文件开头处的版权和版本声明(参见示例1-1)。

(2)       对一些头文件的引用。

(3)       程序的实现体(包括数据和代码)。

假设定义文件的名称为 graphics.cpp定义文件的结构参见示例1-3

 

// 版权和版本声明见示例1-1,此处省略。

 

#include “graphics.h”     // 引用头文件

 

// 全局函数的实现体

void Function1(…)

{

}

 

// 类成员函数的实现体

void Box::Draw(…)

{

}

示例1-3 C++/C定义文件的结构

1.4 头文件的作用

早期的编程语言如BasicFortran没有头文件的概念,C++/C语言的初学者虽然会用使用头文件,但常常不明其理。这里对头文件的作用略作解释:

1)通过头文件来调用库功能。在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码。

2)头文件能加强类型安全检查。如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。

1.5 目录结构

如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。

例如可将头文件保存于include目录,将定义文件保存于source目录(可以是多级目录)。

如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。

 

相关文章推荐

高质量C++/C编程指南 -- 第1章 文件结构

第 1 章 文件结构 每个 C++/C 程序通常分为两个文件。一个文件用于保存程序的声明( declaration ),称为头文件。另一个文件用于保存程序的实现( implementation ),...

高质量的C++编程指南总结(一):文件结构、程序版式、命名规则、表达式和基本语句

在此非常感谢林锐博士的《高质量C++/C编程指南》一文,帮我解决了很多疑惑。现在将文中的一些知识总结一下,以备后用。 第一章 文件的结构 C++/C程序由用于声明的头文件和用于实现的定义文件组成。 头...

高质量C/C++编程指南--文件结构

此系列文章实为对《高质量程序设计指南--C++/C语言》的重点摘要总结 本篇总结的为文件结构:   每个C/C++程序通常都会有两类文件,一为头文件 (.h),  另一类为源文件 (.c) / ...

Google C++编程规范(一)————(头文件篇)

开始在csdn上写一些文章了; 就拿《Google C++ Style Guide》开刀吧 :);本文不是完全一字一句对应翻译。而是本人边看边写个人理解。 头文件(Header Files)  一般来...

谷歌C++编程规范(一)----头文件

今天晚上在网上发现了谷歌的C++编程规范这个东西,大家貌似都非常推崇的样子。然后又在网上搜了一下,好像并没有中文版的。所以,我就打算把它们全都翻译一遍啦,既能提高自己的英语水平,还有助于养成良好的编程...

Windows客户端C/C++编程规范“建议”——文件

本文涉及C++编程中文件的规范相关建议

Google C++编程规范学习--头文件

1、使用#define防止多次包含(multiple inclusion),宏命令规则:project_path_file_H_,如项目test中include目录下一个文件foo.h,宏定义为:#d...
  • lfs99
  • lfs99
  • 2016-12-11 23:41
  • 111

C++编程规范 头文件格式 和 函数注释格式

C++编码规范(1):代码注释 当你阅读别人的代码时如果没有注释那会是件比较痛苦的事.一说到注释我们马上想到是通过//或/* */这样来添加一些描述信息.这只是狭义的注释. 广义的...

第1章 C++编程简介

  • 2013-09-16 16:29
  • 326KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)