记录一下Doxygen对这软件的使用。刚开始觉得这软件很不方便,但摸索了几次之后,个人感觉还好吧!
一、首先,先安装一个doxygen,开源软件,网上随便下,以为我不生成其它杂七杂八的东西,我只下了doxygen。
二、然后,使用doxygen,用它生成c++的帮助文档。
1. 打开doxywizard.exe,若Doxygen没有生成doxywizard.exe快捷方式,可以该软件的文件夹的bin文件中找到,如
双击打开后,
2.在Wizard的project中,选择Doxygen的工作目录,即就是用来存放配置文件的目录,输入项目名称,项目简述(可不写),版本号(可不写),选择源文件,递归收索源文件目录,选择生成文档的存放目录
3. 在Wazard的Mode中, 可直接选择默认
4.在Wazard的Mode中,可直接默认,这里时将LaTex的勾去掉,因为我不需要生成PDF,只需要chm(HTML)就可以了,需要什么格式的注释文档就勾什么,如果需要生成word文档,就选择rtf格式
5.点击“Expert”, 选择project中的OUTPUT_LANGUAGE为Chinese,在DOXYFILE_ENCODING中,UTF-8 是首选。网上说如果需要显示中文则选择GB2312,但是我选了UTF-8,在html格式里中文也可以显示啊!所以能选UTF-8就选它吧。
6. 点击Bulid,按需要选择勾选
Build页面,这个页面是生成帮助信息中比较关键的配置页面:
EXTRACT_ALL 表示:输出所有的函数,但是private和static函数不属于其管制。
EXTRACT_PRIVATE 表示:输出private函数。
EXTRACT_STATIC 表示:输出static函数。同时还有几个EXTRACT,相应查看文档即可。
HIDE_UNDOC_MEMBERS 表示:那些没有使用doxygen格式描述的文档(函数或类等)就不显示了。当然,如果EXTRACT_ALL被启用,那么这个标志其实是被忽略的。
INTERNAL_DOCS 主要指:是否输出注解中的@internal部分。如果没有被启动,那么注解中所有的@internal部分都将在目标帮助中不可见。
CASE_SENSE_NAMES 表示:是否关注大小写名称,注意,如果开启了,那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说,建议永远不要开启。
HIDE_SCOPE_NAMES 表示:域隐藏,建议永远不要开启。
SHOW_INCLUDE_FILES 表示:是否显示包含文件,如果开启,帮助中会专门生成一个页面,里面包含所有包含文件的列表。
INLINE_INFO :如果开启,那么在帮助文档中,inline函数前面会有一个inline修饰词来标明。
SORT_MEMBER_DOCS :如果开启,那么在帮助文档列表显示的时候,函数名称会排序,否则按照解释的顺序显示。
GENERATE_TODOLIST :是否生成TODOLIST页面,如果开启,那么包含在@todo注解中的内容将会单独生成并显示在一个页面中,其他的GENERATE选项同。
SHOW_USED_FILES :是否在函数或类等的帮助中,最下面显示函数或类的来源文件。
SHOW_FILES :是否显示文件列表页面,如果开启,那么帮助中会存在一个一个文件列表索引页面。
这里我勾选的是前面6个
7. 在Input中,设置Input的INPUT_ENCODING为UTF-8,即输入源码格式为UTF-8,注意输入源文件编码要与源文件编码格式相同,不同最好先转为UTF-8
8.若选择注释文档的格式为rtf,则在Index中选择页数,如图页数5;如之前没有选则生成rtf则忽略
9.在HTML中,HTML_OUTPUT中输入html的文件名,不改默认为html
10.在RUN中,点击Run doxygen
11.点击Show HTML output查看生成的注释文件内容
12. 在选择的目标目录下面,找到带项目名称的文件,双击打开即可查看注释文件
三、Doxygen的注释语法:
1. 注释
注释格式一(常用作类别或是函数批注的一个特定格式):
/**
*
*/
(之前由于开头的/**写成/*,导致注释无法导出)
注释格式二:
///
注释格式三:
//!
2. 常用指令说明:
@file 档案的批注说明。
@author 作者的信息
@brief 用于class 或function的批注中,后面为class 或function的简易说明。
@param
格式为@param arg_name 参数说明
主要用于函式说明中,后面接参数的名字,然后再接关于该参数的说明。
@return 后面接函数传回值的说明。用于function的批注中。说明该函数的传回值。
@retval
格式为@retval value 传回值说明
主要用于函式说明中,说明特定传回值的意义。所以后面要先接一个传回值。然后在放该传回值的说明。
@date 时间信息
@see 参考信息,点击参考可跳转,格式为@see function
@note 注释内容,可译为注解
@attention 警告、注意信息
另:在类别或是函数批注的注释格式中,不需要@+特定标示,直接编写注释信息也可以显示
参考:
https://blog.csdn.net/chenyujing1234/article/details/19115319
https://blog.csdn.net/bailyzheng/article/details/8978648