程序的书写格式.pdfVIP

c 程序的书写格式 c++程序的书写格式 2010-05-18 17 ：03 文件结构文件头注释所有 C++的源文件均 必须包含一个规范的文件头，文件头包含了该文件的名称、功能概述、作者、版权 和版本历史信息等内容。标准文件头的格式为： /* ！@file*PRE 模块名：文件所属 的模块名称文件名：文件名相关文件：与此文件相关的其它文件文件实现功能：描 述该文件实现的主要功能作者：作者部门和姓名版本：当前版本号 -- 备注：其它说 明-- 修改记录：日期版本修改人修改内容 YYYY/MM/DD X.Y作者或修改者名修改内 容/PRE*/ 如果该文件有其它需要说明的地方，还可以专门为此扩展一节： /* ！ @file*PRE 模块名：文件所属的模块名称文件名：文件名相关文件：与此文件相关 的其它文件文件实现功能：描述该文件实现的主要功能作者：作者部门和姓名版 本：当前版本号 -- 备注：其它说明 -- 修改记录：日期版本修改人修改内容 YYYY/MM/DD X.Y作者或修改者名修改内容 /PRE** 项目 1- 项目 1.1- 项目 1.2==* 项目 2- 项目 2.1- 项目 2.2.*/ 每行注释的长度都不应该超过 80 个半角字符。还要注意缩 进和对其，以利阅读。关于文件头的完整例子，请参见：文件头例子关于文件头的 模板，请参见：文件头注释模板头文件头文件通常由以下几部分组成：文件头注释 每个头文件，无论是内部的还是外部的，都应该由一个规范的文件头注释作为开 始。预处理块为了防止头文件被重复引用，应当用 ifndef/define/endif 结构产生 预处理块。函数和类 / 结构的声明等声明模块的接口需要包含的内联函数定义文件 ( 如果有的话 ) 如果类中的内联函数较多，或者一个头文件中包含多个类的定义 ( 不 推荐 ) ，可以将所有内联函数定义放入一个单独的内联函数定义文件中，并在类声 明之后用 #include 指令把它包含进来。头文件的编码规则：引用文件的格式用 #include filename.h 格式来引用标准库和系统库的头文件 ( 编译器将从标准库目 录开始搜索 ) 。用#includefilename.h 格式来引用当前工程中的头文件 ( 编译器将 从该文件所在目录开始搜索 ) 。分割多组接口 ( 如果有的话 ) 如果在一个头件中定义 了多个类或者多组接口 ( 不推荐 ) ，为了便于浏览，应该在每个类 / 每组接口间使用 分割带把它们相互分开。关于头文件的完整例子，请参见：头文件例子内联函数定 义文件如上所述，在内联函数较多的情况下，为了避免头文件过长、版面混乱，可 以将所有的内联函数定义移到一个单独的文件中去，然后再用 #include 指令将它 包含到类声明的后面。这样的文件称为一个内联函数定义文件。按照惯例，应该将 这个文件命名为 filename.inl ，其中 filename 与相应的头文件和实现文件相 同。内联函数定义文件由以下几部分组成：文件头注释每内联函数定义文件都应该 由一个规范的文件头注释作为开始内联函数定义内联函数的实现体内联函数定义文 件的编码规则：分割多组接口 ( 如果有的话 ) 如果在一个内联函数定义文件中定义了 多个类或者多组接口的内联函数 ( 不推荐 ) ，必须在每个类 / 每组接口间使用分割带 把它们相互分开。文件组成中为什么没有预处理块 ?与头文件不同，内联函数定义 文件通常不需要定义预处理块，这是因为它通常被包含在与其相应的头文件预处理 块内。关于内联函数定义文件的完整例子，请参见：内联函数定义文件例子实现文 件实现文件包含所有数据和代码的实