Doxygen简介及使用说明.pdf
需积分: 5 187 浏览量
2019-08-09
15:47:10
上传
评论
收藏 360KB PDF 举报
一、 Doxygen 简介
Doxygen 是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或
者说是 API 参考手册，从而减少程序员整理文档的时间。当然这里程序中的注
释需要遵循一定的规则书写，才能让 Doxygen 识别和转化。
目前 Doxygen 可处理的程序语言包含 C/C++、Java、Objective-C、IDL 等，可产
生出来的文档格式有 HTML、XML、LaTeX、RTF 等，此外还可衍生出不少其它格
式，如 HTML 可以打包成 CHM 格式，而 LaTeX 可以通过一些工具产生出 PS 或
是 PDF 文档等。
二、 下载及安装
Doxygen 官网分别提供 Linux 和 Windows 下的源代码编译安装包和二进制安装
包 。 方 便 起 见 ， 我 们 选 择 二 进 制 包 进 行 下 载 和 安 装 。 下 载 路 径 为 ：
http://www.stack.nl/~dimitri/doxygen/download.html。
Windows 平台下，下载完成后，直接按照对话框提示安装即可。
另外，也可以安装一些辅助工具来生成更加漂亮的文档。如可以使用 graphviz
中的 dot 工具来渲染出效果更好的图表，因此，如果需要在注释中加入图表可
以下载并安装 GraphViz(http://www.graphviz.org/Download..php) ； Windows 平
台下还可以安装 Windows Help Workshop 来生成 CHM 格式的文档等等。
三、 代码的注释格式
并非所有程序代码中的注释都会被 Doxygen 所处理，而是必须依照正确的格式
撰写。原则上，Doxygen 仅处理与程序结构相关的注释，如 Function，Class
等。对于 Function 内部的注释则不做处理。
Doxygen 中常用指令的说明如下表所示：
@file
源码文件的注释说明。
@author
作者的信息
@brief
用于 class 或 function 的注释中，后面为 class 或 function 的简易说明。
@param
格式为@param arg_name 参数说明
主要用于函式说明中，后面接参数的名字，然后再接关于该参数的说明。
@return
后面接函数传回值的说明。用于 function 的注释中。说明该函数的传回值。
剩余10页未读，继续阅读
资源评论
