- Doxygen是一个程序的文档产生工具,可以将程序中的注释转换成说明文档或者说是API参考手册
- 目前Doxygen可处理的程序语言包含C/C++, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL等,可产生出来的文档格式有HTML、XML、LaTeX、RTF等
- Doxygen
- graphviz
- 在默认情况下,Doxyfile 把
CLASS_DIAGRAMS
标记设置为Yes
。这个标记用来生成类层次结构图。要想生成更好的视图,可以从 Graphviz 下载站点 下载 dot 工具。 - Graphviz的是AT&T Labs Research开发的图形绘制工具,他可以很方便的用来绘制结构化的图形网络,支持多种格式输出,生成图片的质量和速度都不错.
- 下载地址:https://www.graphviz.org/download/
- 在默认情况下,Doxyfile 把
DOT_PATH
GraphViz安装路径RECURSIVE
是否递归扫描子目录
-
简单注释
-
单行注释
/// //!
-
多行注释
/** /*!
-
-
文件注释
/** * @file 文件名 * @brief 简介 * @details 细节 * @mainpage 工程概览 * @author 作者 * @email 邮箱 * @version 版本号 * @date 年-月-日 * @license 版权 */
-
常用注释关键字
@author
作者@brief
摘要license
版权信息@bug
被标记的代码会在Bug列表中出现@class
类名- 格式:
@class <name> [<header-file>] [<header-name>]
- eg:
@class Test"test/test.h"
- 格式:
@date
日期@file
文件名,可以默认为空,DoxyGen会自己加@param
函数参数名及其说明@return
描述该函数的返回值情况- eg:
@return 本函数返回执行结果,若成功则返回TRUE,否则返回FLASE
- eg:
@retval
描述返回值类型- eg:
@retval NULL
空字符串。 @retval !NULL
非空字符串。
- eg:
@note
注解@attention
注意@name
分组名@warning
警告信息@enum
引用了某个枚举,Doxygen会在该枚举处产生一个链接- eg:
@enum CTest::MyEnum
- eg:
@var
引用了某个变量,Doxygen会在该枚举处产生一个链接- eg:
@var CTest::m_FileKey`@exception
可能产生的异常描述- eg:
@exception 本函数执行可能会产生超出范围的异常
- eg:
@todo
对将要做的事情进行注释@see
see also字段@relates <name>
通常用做把非成员函数的注释文档包含在类的说明文档中。@since
从哪个版本后开始有这个函数的@code
在注释中开始说明一段代码,直到@endcode
命令。@endcode
在注释中代码段的结束。@remarks
备注@pre
用来说明代码项的前提条件。@post
用来说明代码项之后的使用条件。@deprecated
这个函数可能会在将来的版本中取消。@defgroup
模块名@{
模块开始@}
模块结束@version
版本号@fn
声明一个函数@par
开始一个段落,段落名称描述由你自己指定,比如可以写一段示例代码-
一级项目符号-#
二级项目符号