C++编码规范.docVIP

北京四方继保自动化 股份有限公司 作业指导书 文件名称：C++编码规范 文件编号：SF-研发中心-0X00 编制 日期 审核 日期 批准 日期 目的 良好的编程风格是提高程序可靠性非常重要的手段，也是在大的软件项目中多人合作开发的基础。为了提高我公司C++源程序的质量和可维护性，通过本规范定义来规避不好的编程风格，增强代码的可读性与可维护性，以便于自己和他人阅读。 适用范围 本规范适用于软件开发中心所开发的后台软件、主站系统平台及应用软件的C++编码。 职责 编码人员：遵照本编码规范进行代码编写。 代码审查人员：执行代码走查，确认实际代码与编码规范的符合性。 相关文件 《高质量C++编程指南》 《软件中心源代码编制规范》 《CC++编程规范》 《ZDH2004101401-自动化室编程规范（C及C++部分）》 《软件中心源代码编制规范》 定义 无 编码规范 概述 前言 为了保证软件程序的质量，提高程序的可维护性和可测试性，特制定本C++编程规范。 本规范主要规定了公司软件研发中心C++程序的编码内容及规则，适用于公司所有使用C++语言开发的高级应用软件模块和软件产品。 本规范中的举例，只是针对具体的某一条规范而加以说明，有可能并不符合其他的规范，例如变量定义的举例，对变量的定义做了说明，但在规范的其它举例中，并没有使用规定的定义方法，请使用者加以注意。 规范中的某些内容是属于必须执行的，标有【规范】字样；某些内容是属于建议性的，标有【建议】字样。 规范制定原则 方便代码的交流和维护。 只规定需要规定的事情，不要强制施加个人喜好或者过时的做法。 不影响编码的效率，不与大众习惯冲突。 使代码更加美观、阅读更为方便。 正确、简单和清晰第一，坚持KISS（Keep It Simple Software）eclaration) file . name.cfg Compile declaration file 注意：严禁使用中文命名文件名。 程序文件内容 源程序文件内容 完整的程序文件由若干部分内容构成，各部分内容及一般顺序如下： 文件头部注释 说明该文件模块的功能和内容（函数、外部数据说明等）。应列出版本号，生成日期，作者，主要函数及其功能，修改日志等。 各种定义及类型定义 Defines和typedefs，其顺序为： “constant” macro “function” macro typedefs enums 全局（外部）数据说明 Global (external) data declarations , 其顺序为： externs non-static globals static globals 如果一组defines仅应用于某一特定的全局数据块（如标志字），则该defines应紧跟在此数据说明之后，或嵌入到结构说明之中。 函数模块 功能类似的函数应尽量放在一起，每一函数之前应有函数头部注释，主要提供函数的接口说明，内容包括函数基本功能描述、出入口参数、调用关系，必要时也应包括实现算法。 函数体中，根据需要可有代码块注释，它可对某个代码块的功能、编程技巧及临时变量进行说明。 头文件内容 头文件中一般允许放下列内容： ? 宏定义 ? 各种数据结构说明 ? typedefs说明 ? 外部函数说明 ? 全局变量说明 【规范】【规范】用 #include filename.h 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。【规范】用 #include “filename.h” 格式来引用自定义/非标准库的头文件（编译器将从用户的工作目录或者指定的路径开始搜索）。【规范】【规范】【规范】 【】头文件保存在include目录，程序文件保存在source或者src目录（可以根据需要设置为多级目录），资源文件保存在res目录，执行文件保存在bin目录，LIB库文件保存在lib目录，配置文件保存在config目录。【】对于某个程序文件所私有的头文件，没有必要公开“声明”。为了加强信息隐藏，这些私有的头文件可以存放于定义文件目录” private/nameP.h”。【】【】【】在头文件中只存放“声明”而不存放“定义”。【】【】【规范】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。… …) { … … //空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else {