我们都知道C/C++程序主要分为两类文件
,一种是用于保存程序的声明,称为头文件(.h),另一种用来保存程序的实现,称为源文件(.c/.cpp)。初学者虽然知道这两句话,但作为企业标准化开发时,这两种文件中到底该写什么,哪些是必须写,哪些东西可以不写等等不是很清楚。下面将提供一些标准化写法的建议:
1.头文件(.h文件)中顺序(结构)一般如下:
(1)头文件注解(包括文件说明、功能描述、版权声明等) (必须有)
(2)内部包含卫哨开始(#ifndef XXX/#define XXX) (必须有)
(3)#include其他头文件(如果需要)
(4)外部变量和全局函数声明(如果需要)
(5)常量和宏定义(如果需要)
(6)类型前置声明和定义(如果需要)
(7)全局函数原型和内联函数的定义(如果需要)
(8)内部包含卫哨结束:#endif // XXX(必须有)
(9)文件版本及修订说明
2.源文件(.c/.cpp文件)其结构一般如下:
(1)源文件注解(包含文件说明、功能描述、版权声明等)(必须有)
(2)预处理指令(如果需要)
(3)常量和宏定义(如果需要)
(4)外部变量声明和全局变量定义及初始化(如果需要)
(5)成员函数和全局函数的定义(如果需要)
(6)文件按修改记录