推荐下载doxygen注释范例word范文模板 25页.docx
- 文档编号:10993428
- 上传时间:2023-02-24
- 格式:DOCX
- 页数:24
- 大小:22.43KB
推荐下载doxygen注释范例word范文模板 25页.docx
《推荐下载doxygen注释范例word范文模板 25页.docx》由会员分享,可在线阅读,更多相关《推荐下载doxygen注释范例word范文模板 25页.docx(24页珍藏版)》请在冰豆网上搜索。
推荐下载doxygen注释范例word范文模板25页
本文部分内容来自网络整理,本司不为其真实性负责,如有异议或侵权请及时联系,本司将立即删除!
==本文为word格式,下载后可方便编辑和修改!
==
doxygen注释范例
篇一:
doxygen常用注释语法
2.常用注释语法
注释写在对应的函数或变量前面。
简要注释和详细注释:
/**
*@briefBriefDescription.
*
*DetailedDescription
*/
简要注释遇到一个空行或新的命令会结束,后面的就表示是详细注释。
JavaDoc风格下,自动会把第一个句号前的文本作为简要注释,后面的为详细注释。
你也可以用空行把简要注释和详细注释分开。
注意要设置JAVADOC_AUTOBRIEF设为YES。
为了注释一个类中的member,首先要对该类作注释。
同样的问题上升到namespace。
要注释一个全局的function,typedef,enum或preprocessor定义,你需要首先定义(只能用@file,因为文件不再任何东西里面,就只能用特殊命令实现了,而不像类、函数等,既可以在上方放注释,也可以用@class、@fn进行注释)包含它的文件。
(1)文件头注释
/**@file[file‐name]
*@briefbriefdescription
*@author
*[@author
*@date
*@version
*@note
*detaileddescription
*/
一般@file后我们空着,Doxygen会默认为是@file所在文件的文件名。
[]表示可选,{}表示重复0到N次,<>表示必须参数。
@author表示作者,@data表示日期,@version表示版本号。
(2)类注释
/**
*@class
*@briefbriefdescription
*@author
*@note
*detaileddescription
*/
header‐file是类声明所在的头文件名字,header‐name是要显示的链接文字,一般为头文件的真实路径。
(3)函数注释
/**
*@briefbriefdescription
*@author
*{@param[in|out]
*@exception
*{@exception
*@return
*{@return
*@note
*detaileddescription
*@remarks
*{@remarks
*[@deprecated
*[@sincewhen(timeorversion)]
*[@seereferences{,references}]
*/
@可用\代替,但我倾向于用@。
@param[in|out]参数名及其解释
@exception用来说明异常类及抛出条件
@return对函数返回值做解释
@note表示注解,暴露给源码阅读者的文档
@remark表示评论,暴露给客户程序员的文档
@since表示从那个版本起开始有了这个函数
@deprecated引起不推荐使用的警告
@see表示交叉参考
函数的详细注释用@note代替详细注释,因为详细注释要空行隔开,容易忘记。
(4)成员注释
/**<或//<用来注释成员,放在成员后面,格式如下:
intvar;/** intvar;/// 此语法对函数成员也适用。 (5)枚举类型注释 /**@briefAnotherenum,withinlinedocs*/ enumAnotherEnum { V1,/** V2/** }; 一般约定: (1)每个.h和.cpp文件的头部,必须要有简要注释和详细注释,习惯用法如下: /**@file *@briefbriefdescription *@author *@date *@version *@note *detaileddescription */ (2)每个类的声明上方,必须要有简要注释和详细注释,习惯用法如下: /** *@class *@briefbriefdescription *@author *@note *detaileddescription */ (3)全局变量和全局宏必须要有注释。 如果注释较短,则可以在上方用 /**@briefsomebriefdescription*/或右方用 /// 进行简要注释。 (4)任何函数都必须要有简要注释和详细注释,习惯用法如下: /** *@briefbriefdescription *@author *@param[in|out] *@exception *@return *@note *detaileddescription *@remarks */ 对于类的函数成员,在头文件的定义处进行简要注释,放在上方: classTest { public: /**@briefbriefdescription*/ intm_test(inta); } 而在实现出给出详细注释: /** *@author *@param[in|out] *@exception *@return *@note *detaileddescription *@remarks */ intTest: : m_test(inta) { Return0; } 纯虚函数由于没有实现则简要注释和详细注释不需分开。 对于类的数据成员,只在头文件的定义处进行简要注释,不要详细注释。 可以在上方用/**@briefsomebriefdescription*/或右方用/// (5)每个枚举定义必须添加注释,格式如下: /**Anotherenum,withinlinedocs*/ enumAnotherEnum { V1,// V2// }; 下面是一个简单的例子,完全符合约定: /**@file *@briefabriefdescriptionforthefile. *@authorsoulmachine *@date201X/07/02 *@version0.1 * *detaileddescriptionfortest.cpp */ /**@briefglobalfunction,nodetails *@notesomedetailsaboutglobalfunction */ voidglobal_test(); /**@classTesttest.h"inc/test.h" *@briefAtestclass. * *Amoreelaborateclassdescription. */ classTest { public: /**@briefAenum,withinlinedocs*/ enumTEnum{ TVal1,/** TVal2,/** TVal3/** } //这里Doxygen对enumPtr的处理有点问题 *enumPtr,/// enumVar;/// /**@briefAconstructor.*/ Test(); /**@briefAdestructor.*/ ~Test(); /**@briefanormalmembertakingtwoargumentsandreturninganintegervalue.*/inttestMe(inta,constchar*s); /**@briefApurevirtualmember. *@param[in]c1thefirstargument. *@param[in]c2thesecondargument. *@seetestMe() */ virtualvoidtestMeToo(charc1,charc2)=0; intpublicVar;// /**@briefafunctionvariable,noteDetails.*/ int(*handler)(inta,intb); /**@briefbriefbeforedelaration*/ intm_func(inta); }; /**Amoreelaboratedescriptionoftheconstructor.*/ Test: : Test() { } /**Amoreelaboratedescriptionofthedestructor.*/Test: : ~Test() { } /** *@param[in]aanintegerargument. *@param[in]saconstantcharacterpointer. *@returnThetestresults *@noteDetails. *@par *Anotherdetail. *@seeTest() *@see~Test() *@seetestMeToo() *@seepublicVar() */ intTest: : testMe(inta,constchar*s) { return0; } /** *@param[in]aainterger *@return0 *@notedetaileddescription *@remarksremarks,important *@since1.0 *@seetestMeToo */ intTest: : m_func(inta) { return0; } 篇二: 基于doxygen的C++注释规范笔记 基于doxygen的文档注释学习笔记 文件注释 /** *@file文件名 *@brief概述 * *详细概述 * *@author作者,包含email等 *@version版本号(maj.min,主版本.分版本格式) *@data日期 */ 命名空间的注释 ///@brief简单概述 /// ///详细概述 类定义注释 对需要的类增加注释,需要说明类的设计方法,类的使用指南,说明类的不变项 ///@brief简要概述 /// ///详细说明 /// ///使用指南设计函数调用可以@ref函数名用于引用其他的说明 /// ///其他说明,重写父类函数加以特殊实现 /// ///@invariant类不变项,例如哪些值不会超多少多少 /// classxxx {… 数据声明注释 行尾说明 TypevarName;///<说明 多行说明 ///说明 /// /// TypevarName; 函数注释规范 ///@brief简单概述 /// ///详细说明 ///@param[in|out]参数名,in,out表示输入还是输出///@pre前者条件 ///@return说明 ///@retval返回值说明,这个是可选的///@post说明函数完成后的世界状态 代码标记数值规范 ///@todo将要做的代码 ///@bug表示此处的bug描述 篇三: doxygen标准VC注释_完整的配置步骤 C++程序文档生成器介绍(doxygen)程序文档,曾经是程序员的一个头痛问题。 写一个程序文档,比较花时间,但不是很难;麻烦的是当程序修改后,程序文档也要跟着同步更新,否则文档和程序就要脱节,文档也就变成没用的东西了。 好在有许多好用的文档生成器来解决这个问题。 目前比较流行的C++文档生成器是doxygen。 本文就简单的介绍一下doxygen的文档注释方法,以供初学者参考: 1.模块定义(单独显示一页) /* *@defgroup模块名模块的说明文字 *@{ */ ...定义的内容... /**@}*///模块结尾 2.分组定义(在一页内分组显示) /* *@name分组说明文字 *@{ */ ...定义的内容... /**@}*/ 3.变量、宏定义、类型定义简要说明 /**简要说明文字*/ #defineFLOATfloat /**@brief简要说明文字(在前面加@brief是标准格式)#defineMIN_UINT0*/ /* *分行的简要说明\n *这是第二行的简要说明 */ intb; 4.函数说明 /* *简要的函数说明文字 *@param[in]param1参数1说明 *@param[out]param2参数2说明 *@return返回值说明 */ intfunc(intparam1,intparam2); /* *打开文件\n *文件打开成功后,必须使用: : CloseFile函数关闭。 *@param[in]file_name文件名字符串 *@param[in]file_mode文件打开模式字符串,可以由以下几个模块组合而成: *-r读取 *-w可写 *-a添加 *-t文本模式(不能与b联用) *-b二进制模式(不能与t联用) *@return返回文件编号 *--1表示打开文件失败 *@note文件打开成功后,必须使用: : CloseFile函数关闭 *@par示例: *@code //用文本只读方式打开文件 intf=OpenFile("d: \\test.txt","rt"); *@endcode *@see: : ReadFile: : WriteFile: : CloseFile *@deprecated由于特殊的原因,这个函数可能会在将来的版本中取消。 */ intOpenFile(constchar*file_name,constchar*file_mode); 5.枚举类型定义 /**枚举常量*/ typedefenumTDayOfWeek { SUN=0,/**<星期天(注意,要以“<”小于号开头)*/ MON=1,/**<星期一*/ TUE=2,/**<星期二*/ WED=3,/**<星期三*/ THU=4,/**<星期四*/ FRI=5,/**<星期五*/ SAT=6/**<星期六*/ } /**定义类型TEnumDayOfWeek*/ TEnumDayOfWeek; 6.类的注释说明(实例) -----------------------------ExampleBegin--------------------------------- #文件的注释格式 #注释文件,格式: ///@file文件名文件的简短注释. ///@filesocket_c.hheadfileofclasssocket_c. #文件的详细注释. ///Definetheinterfaceofclasssocket_c. #普通注释,不会生成在文档中. //$Id: socket_c.h287201X-06-2806: 20: 41Zhorin$ #类的注释,格式: ///@brief简短注释内容. ///@briefclassofserversocket. classsocket_c { private: public: #函数的注释格式 #函数的注释,格式: ///@brief函数的简短注释. ///@briefhandletheconnectionsofclients. #参数注释,格式: ///@param参数的简短注释. ///@paramservertheserveripaddress. ///@paramserv_porttheserver#port. #返回值注释,格式: ///@return返回值的简短注释. ///@returnconnectedsocketfd. #具体返回值的注释,格式: ///@retval返回值该返回值的注释. ///@retvalconnfdonsuccess. ///@retval0onEINTR-systemcall. ///@retval-1onerror. #参见...,格式: ///@see参见的类/文件等. ///@seemain_ppc.cpp intaccept_client(constintlistenfd); }; #自定义类型的注释 ///@briefstructureofchildprocess. structchild_proc_s { #行尾的注释,格式: ///<注释内容. pid_tchild_pid;/// intchild_pipefd;/// }; #全局变量的注释,也可以采用上面的行尾格式进行注释. ///gloablevariableforsignal. pid_tg_pid=0; -----------------------------ExampleEnd--------------------------------- 7.配置文件的生成与修改 Doxygen的功能强大,配置选项也十分多.如果是命令行模式,有些不便.因此建议使用GUI的Doxywizard(可以从<开始>菜单中运行).下面就对我个人认为比较重要的选项,并结合实例(生成html文档)进行简单说明. 下面列出的一般是需要修改的,未列出的我采用缺省值. #Project选项 #--------------------------------------------------------------------------- #Staff_TPC是生成文档的项目名,会显示在文档中. PROJECT_NAME=Staff_TPC PROJECT_NUMBER=1.0#项目版本号 #生成文档的输出路径 OUTPUT_DIRECTORY="f: /MyDocuments/cpp/horin/staff/" #生成文档的语言,缺省是English,也可以是简体中文等. OUTPUT_LANGUAGE=English JAVADOC_AUTOBRIEF=YES#打开此选项. #Build选项 #--------------------------------------------------------------------------- SHOW_INCLUDE_FILES=NO#不显示所有包括的文件. #input选项 #--------------------------------------------------------------------------- #要生成文档的源文件的路径.如果是一个目录,则是该目录下的所有文件;当然,也可以#是具体的某个文件. INPUT="f: /MyDocuments/cpp/horin/staff/tpc/" #输入文件的匹配模式,下面是c/c++语言的设置. FILE_PATTERNS=*.c\ *.cpp\ *.h\ *.hpp RECURSIVE=YES#需要递归处理子目录. #sourcebrowser选项 #--------------------------------------------------------------------------- #如为SOURCE_BROWSER和INLINE_SOURCES都设置为YES,则生成的文档中会包括源代码 #(即.cpp文件),这可以方便阅读时查看源代码. SOURCE_BROWSER=NO INLINE_SOURCES=NO STRIP_CODE_COMMEN
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 推荐下载doxygen注释范例word范文模板 25页 推荐 下载 doxygen 注释 范例 word 范文 模板 25