C++编码规范1.2.docVIP

C++编码规范 北京国科恒通电气自动化科技有限公司 2009年7月 目录 1 程序结构 3 1.1 目录结构 3 1.2 文件结构 3 1.2.1 头文件 3 1.2.2 实现文件 5 2 命名规则 7 2.1 文件 7 2.2 类/结构 7 2.3 函数 8 2.4 变量 8 2.5 常量 10 2.6 枚举、联合、typedef 10 2.7 宏 10 3 代码风格与版式 11 3.1 类/结构 13 3.2 函数 15 3.3 变量、常量 16 3.4 表达式和基本语句 17 3.5 枚举、联合、typedef 18 3.6 宏 19 4 注释 20 Doxygen支持的指令 20 注释风格约定 21 类成员变量定义示例 22 成员函数的注释示例 23 枚举变量的注释示例 23 5 其他说明 23 程序结构 目录结构 目录名以一个或多个单词组成，每个单词首字母大写； 如：CommonAFX DMSView 每个工程的私有资源文件放在工程目录下的Res中； 文件结构 C++程序主要的两类文件是头文件和实现文件，分别以“.h”和“.cpp”为后缀。 预编译头文件名称为：StdAfx.h 对应cpp为：StdAfx.cpp 头文件和实现文件内容最后留一空行，否则Linux下编译有警告。 Qt工程特殊实现文件：moc、qrc文件不加入工程，只通过一个特殊的实现文件AutoGen.cppx包含这些自动生成的文件； 注：采用AutoGen.cppx而不是AutoGen.cpp主要是通过pro实现跨平台编译的需要，否则在Linux下编译时会出现moc重复包含的问题。 头文件头文件通常由以下几部分组成： 预处理块 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。 文件引用 用 #include filename.h 格式来引用标准库和系统库的头文件（编译器将从标准库目录开始有哪些信誉好的足球投注网站）用 #include filename.h 格式来引用当前工程中的头文件（编译器将从该文件所在目录开始有哪些信誉好的足球投注网站） 类结构的声明 典型头文件（GMapWidget.h）如下： #ifndef _GMAPWIDGET_H_ #define _GMAPWIDGET_H_ #include GViewDef.h #include math.h #include QWidget … #include “MyHeader.h” … class QPushButton; class GDocument; /// 地图窗口 /// 实现地图的绘制，基于OpenGL实现 class GVIEW_API GMapWidget : public QWidget { public: GMapWidget(GView * pView); ~GMapWidget(); /// 获取窗口对应的文档 GDocument * getDocument() const; /// 在GIS图上定位设备 /// 说明：对于点状对象, 包括变电站, 配电站, 电杆, 负荷等, 定位到设备所在的、/// 点; 对于分支, 定位到组成该分支的所有线段(不包括下级分支); 对于馈/// 线, 定位到主干线的所有线段(不包括下级分支). /// 参数: IN nDevID 需要定位对象的DevID. /// IN eAction 定位对象所采用的方法 /// IN nFlashCount 找到对象之后, 是否闪烁. /// 返回值：如果地图显示范围已更改则返回true, 否则返回false bool locateObject(int nDevID, ELocateAction eAction, int nFlashCount); private: /// 以给定点为中心，缩放到指定比例 void _zoomToRatio(const GeRect2d gptCenter, double dRatio); /// 缩放到给定范围 Void _zoomToRect(const GeRect2d grectRange); private: GDocument * m_pDocument; /// 窗口对应的文档 }; #endif 实现文件实现文件包含所有数据和代码的实现体。实现文件的格式为： 对配套头文件的引用 引用声明了此文件实现的类、函数及数据的头文件 对一些仅用于实现的头文件的引用（如果有的话） 将仅与实现相关的接口包含在实