C++(QT)代码风格_命名_注释约定.docx

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