文档介绍：C++设计编码规范
（试用版）
设备开发部 黄焕斌
目录
重要提示 4
背景 4
1 文献组织规则 4
命名 4
目录 4
预解决 4
注释 5
2 代码组织规则 6
空行 6
换行 6
空格 6
对齐 7
就近原则 7
精简原则 7
3 命名规则 9
自注释 9
变量 9
函数 9
类型 10
宏 10
常量 10
4 设计规则 11
辨认类和函数 11
构造函数 11
封装性 12
函数参数 12
函数返回值 13
契约 13
规模 14
名字空间 14
类型转换 14
常量 14
内联 14
静态变量 14
编译依赖 15
可重入 15
5 内存管理规则 16
模块化 16
静态分派 16
new/delete 16
有效性 16
对的释放 16
拷贝 16
6 注释规则 17
有效性 17
普通注释 17
Doxygen注释 17
定义 17
声明 18
模块 18
7 维护规则 19
消除警告 19
代码修改 19
标本兼治 19
参照资料 20
重要提示
本规范中示例代码都在表格框中显示，绿色表格框表达对的示例代码，红色表格框表达不建议示例代码。
背景
C++是大华设备软件和平台软件开发重要软件，在新软件框架里，两种平台组件甚至是共用。统一代码风格，良好设计风格，有助于代码实现和阅读，有助于减少代码错误和提高代码效率，能有效地增进技术交流和发展。
常用代码规范都异常冗长，调调框框太多。本规范力求以简要内容，概括某些重要规则，将相似规则进行提炼集中描述，并提供对照示例代码加深理解。规范使用者花半个小时左右，就可以熟悉整个规范。
所有大华基于新软件框架底层组件，业务组件，应用组件都必要遵守此规范。
例外
本规范是强制规定，但是有些状况例外：
与第三方库关于代码：例如stl,boost,json等等，使用、移植这些库时，有关代码可以按照这些库规范。
Windows代码：重要指基于公共软件框架，同步使用了非公共组件框架内其她API接口组件，可以继续保存Windows规范。
文献组织规则
命名
所有目录和文献名使用大写字母开头单词组合，目录名单词之间可以用空格分开。
引用文献名时要严格区别大小写。
与操作系统关系密切工程命名可以参照操作系统规则。
//源文献
//头文献
//资源文献
Config1 //配备文献
目录
一种大工程是由各种组件或模块构成，对于每个组件或模块，其代码应集中管理，并具备完整设计文档和单元测试代码，用子目录分类存储。
目录或文献
阐明
Bin
测试程序目录
Doc
设计文档目录
Include
依赖组件头文献目录与本组件外部接口头文献目录，映射到其她地址
Lib
不同平台生成库和依赖库文献目录
Makefile不同平台配备文献目录
Src
源文献，内部头文献
Test
单元测试代码
Makefile
Makefile文献，，测试程序
预解决
为了防止头文献被重复引用，使用ifndef/define/endif构造产生预解决块。
预解决宏中单词应与文献名基本一致。
//
#ifndef __GUARD_H__
#define __GUARD_H__
//Guard类定义...
#endif //__GUARD_H__
注释
源文献和头文献头部都应进行注释，列出svn文献ID，版权声明，文献描述(阐明是什么模块或什么类相应文献)，修改记录(修改时间、svn作者、修改内容)，可使用va模板。
对于新加入svn文献，应当其文献属性svn属性列表中加入(svn:keywords，Id)属性。
不要和文献中类或模块注释混淆。
//
// "$Id$“
//
// Copyright (c)1992-，ZheJiang Dahua Technolog