C(QT)代码注释约定.doc

《C(QT)代码注释约定.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、C++(QT)代码注释约定（针对doxygen）Qt代码注释规范一、注释的一般格式1、多行注释/*!***/2、行尾注释///<二、注释位置1、文件注释既有.h文件也有.cpp文件的，在.h文件中注释，注释放在文件内容的最前面，需要说明文件名、文件功能描述、文件版本和文件修改记录，文件修改记录包括文件修改时间、文件版本号、文件修改人和文件修改内容四部分。/*!*file文件名*brief概述**详细概述**author作者*version版本号*date日期**b修改记录：*li日期*-addsetA()*-changedgetA()

2、*li日期*-addsetA()*-changedgetA()*/2、类注释注释放在类之前/*!*class类名*brief概述**详细概述*/3、函数注释函数的注释全部在函数实现处，放在函数内容的前面，其完整的注释包括函数功能描叙、函数参数描述、函数返回值描述、函数错误码描述、函数的补充说明和函数修改记录等多个部分。/*!*brief功能概述*param参数描述(多个参数如何描述)*return返回值描述*/1、变量注释采用行后注释的方式，实现代码的整齐化///<三、注释中常用指令file档案的批注说明。author作者的信息b

3、rief用于class或function的简易说明eg：brief本函数负责打印错误信息串param主要用于函数说明中，后面接参数的名字，然后再接关于该参数的说明return描述该函数的返回值情况eg:return本函数返回执行结果，若成功则返回TRUE，否则返回FLASEretval描述返回值类型eg:retvalNULL空字符串。ote注解attention注意warning警告信息enum引用了某个枚举，Doxygen会在该枚举处产生一个链接eg：enumCTest::MyEnumvar引用了某个变量，Doxygen

4、会在该枚举处产生一个链接eg：varCTest::m_FileKeyclass引用某个类，格式：class[][]eg:classCTest"inc/class.h"exception可能产生的异常描述eg:exception本函数执行可能会产生超出范围的异常todo被此标记说明的代码会在Todo列表中出现bug被此标记说明的代码会在Bug列表中出现test被此标记说明的代码会在Test列表中出现sa参考函数生成链接mainpage主页面显示信息index.htm

5、lref关联页面eg:refrunHowToRunpage页面信息，可与ref对应，链接到此页面Eg:pagerun*.....三、其他1、在一个doxygen注释块中使用brief.这个命令只对当前一个文字段有效,所以详细描述应该与之间隔一个空行.像这样:/*!*brief简要描述.*简要描述.**详细描述.*/2、每个类、以及该类的重要成员函数增加短注释和长注释。短注释应给出类或函数的基本信息的简要描述。而较长的注释，应该给出更长和更完整的描述。类的短注释和长注释，以及成员函数的简短描述，将放在头文件中。成员函数的长注释将出现在成

6、员函数的实现出现的地方。3、如果想对文件、结构体、联合体、类或者枚举的成员进行文档注释的话,并且要在成员中间添加注释,而这些注释往往都是在每个成员后面。可以使用在注释段中使用'<'标识intvar;///

7、------------------------------------------------//includedeclare//---------------------------------------------------------------------------------------------------------------------//--------------------------------------------------------------------------------------------

8、-------------------------//definedeclare//-------------------