软件编码规范文档.doc

C++(试用版)设备开发部黄焕斌目录重要提示 4背景 41 文件组织规则 命名 目录 预处理 注释 52 代码组织规则 空行 换行 空格 对齐 就近原则 精简原则 73 命名规则 自注释 变量 函数 类型 宏 常量 104 设计规则 识别类和函数 构造函数 封装性 函数参数 函数返回值 契约 规模 名字空间 类型转换 常量 联 静态变量 编译依赖 可重入 155 存管理规则 模块化 静态分配 new/delete 有效性 正确释放 拷贝 166 注释规则 有效性 普通注释 Doxygen注释 定义 申明 模块 187 维护规则 消除警告 代码修改 标本兼治 19参考资料 20重要提示 本规中的示例代码都在表格框中显示,绿色的表格框表示正确的示例代码,红色的表格框表示不建议的示例代码。背景 C++是大华设备软件和平台软件开发的主要软件,在新的软件框架里,两种平台的组件甚至是共用的。统一的代码风格,良好的设计风格,有利于代码的实现和阅读,有利于减少代码错误和提高代码效率,能有效地促进技术的交流和发展。 常见的代码规都异常冗长,调调框框太多。本规力求以简明的容,概括一些重要的规则,将相似的规则进行提炼集中描述,并提供对照的示例代码加深理解。规的使用者花半个小时左右,就可以熟悉整个规。 所有大华基于新软件框架的底层组件,业务组件,应用组件都必须遵守此规。例外 本规是强制要求,不过有些情况例外:与第三方库有关的代码:比如stl,boost,json等等,使用、移植这些库时,相关的代码可以按照这些库的规。Windows代码:主要指基于公共软件框架,同时使用了非公共组件框架的其他API接口的组件,可以继续保留Windows的规。文件组织规则命名所有的目录和文件名使用大写字母开头的单词组合,目录词之间可以用空格分开。引用文件名时要严格区分大小写。与操作系统关系密切的工程的命名可以参考操作系统的规则。 // // //资源文件Config1 //配置文件目录 一个大的工程是由多个组件或模块组成的,对于每个组件或模块,其代码应集中管理,并具备完整的设计文档和单元测试代码,用子目录分类存放。目录或文件说明Bin测试程序目录Doc设计文档目录Include依赖的组件头文件目录与本组件的外部接口头文件目录,,,,测试程序预处理为了防止头文件被重复引用,使用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-2007,.//AllRightsReserved.//// Description:// Revisions: Year-Month-DaySVN-AuthorModification//代码组织规则空行类、结构、联合、函数、枚举等定义结束后,应加空行。类定义部相关的成员变量或操作之间不加空行,其他地方应加空行。函数体,逻揖上密切相关的语句之间不加空行,其它地方应加空行。源文件和头文件末尾保留一个空行。classA{};classB;换行每行代码只写一