C++代码风格命名注释约定.docx

C+代码风格命名注释约定C+(QT)代码风格指南与命名约定 l 名称是一些字母和数字构成的序列，第一位不能为数字 l 名称的第一位也可以使用下划线字符(_),不鼓励使用 l 类名称以大写字母开头，如class Customer. l 函数名称以小写字母开头。 l 通过合并多个单词并且让每个单词首字母大写，即使用“驼峰规则”(CamelCase)的方式构造多单词的名称。 l 常量应当大写并且尽可能在类的作用域内创建成枚举值，全局常量和宏通常应当都是全部大写。 l 每一个类名称都应当是一个名词或者名词短语。 l 每一个函数名称都应当是一个动词或者动词短语。 l 用于if语句，每一个布尔量都应当近似于一个句子，例如，bool isQualified l 数据成员：m_Color,以小写字母m 开头。 l 静态数据成员：s_Singleton,以小写字母s开头。 l 属性 Ø 非布尔型容器获取器：color或者getColor Ø 布尔型获取器：isChecked或者isValid Ø 设置器：setColor(const Color& newColor) l 结构体定义 考虑到结果体字节对齐问题，定义时相同类型成员应定义在一起，并且，所占字节数多的定义在前。 l 前置定义 类成员变量定义为指针，头文件中进行前置定义，可以减少包含的头文件。 全局变量、结构体尽量定义在自定义命名空间中，其他头文件中引用可以采用命名空间前置定义。 C+(QT)代码注释约定 Qt代码注释规范 一、注释的一般格式 1、多行注释 /*! * * */ 2、行尾注释 /< 二、注释位置 1、文件注释 既有.h文件也有 .cpp文件的，在.h文件中注释，注释放在文件内容的最前面，需要说明文件名、文件功能描述、文件版本和文件修改记录，文件修改记录包括文件修改时间、文件版本号、文件修改人和文件修改内容四部分。 /*! * file 文件名 * brief 概述 * *详细概述 * *author 作者 *version 版本号 *date 日期 * * b 修改记录： * li 日期 * - add setA * - changed getA * li 日期 * - add setA * - changed getA */ 2、类注释 注释放在类之前 /*! * class 类名 * brief 概述 * * 详细概述 */ 3、函数注释 函数的注释全部在函数实现处，放在函数内容的前面，其完整的注释包括函数功能描叙、函数参数描述、函数返回值描述、函数错误码描述、函数的补充说明和函数修改记录等多个部分。 /*! * brief 功能概述 * param 参数描述( 多个参数如何描述) * return 返回值描述 */ 4、变量注释 采用行后注释的方式，实现代码的整齐化 /< 三、注释中常用指令 file author brief 档案的批注说明。 作者的信息 用于class 或function的简易说明 eg： brief 本函数负责打印错误信息串 主要用于函数说明中，后面接参数的名字，然后再接关于该参数的说明 描述该函数的返回值情况 eg: return 本函数返回执行结果，若成功则返回TRUE，否则返回FLASE 描述返回值类型 eg: retval NULL 空字符串。 注解 注意 警告信息 引用了某个枚举，Doxygen会在该枚举处产生一个链接 eg： enum CTest:MyEnum 引用了某个变量，Doxygen会在该枚举处产生一个链接 eg： var CTest:m_FileKey 引用某个类， 格式：class <name> <header-file> <header-name> eg: class CTest "inc/class.h" 可能产生的异常描述 eg: exception 本函数执行可能会产生超出范围的异常 被此标记说明的代码会在Todo列表中出现 被此标记说明的代码会在Bug列表中出现 被此标记说明的代码会在Test列表中出现 参考函数 生成链接 主页面显示信息 index.html param return retval note attention warning enum var class exception todo bug test sa mainpage ref page 关联页面 eg: ref run How To Run 页面信息，可与 ref对应，链接到此页面 Eg: page run *. 四、其他 1、在一个doxygen注释块中使用 brief . 这个命令只对当前一个文字段有效, 所以详细描述应该与之间隔一个空行. 像这样: /*! * brief 简要描述. * 简要描述. * * 详细描述. */ 2、每个类、以及该类的重要成员函数增加短注释和长注释。短注释应给出类或函数的基本信息的简要描述。而较长的注释，应该给出更长和更完整的描述。类的短注释和长注释，以及成员函数的简短描述，将放在头文件中。成员函数的长注释将出现在成员函数的实现出现的地方。 3、如果想对文件、结构体、联合体、类或者枚举的成员进行文档注释的话, 并且要在成员中间添加注释, 而这些注释往往都是在每个成员后面。可以使用在注释段中使用'<'标识 int var; /<Detailed description after the member 这种注释方法只能在成员和参数中使用。它们不能用在描述文件、类、联合体、名字空间和枚举本身。 Qt代码风格： 1.代码中以固定方式将代码按模块划分 /- /include declare /- /- /define declare /- /- /class declare /- 2.代码中，如果if(a = 0)内容很长，在结尾处添加 /end if(a = 0)