简介
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxygen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。
安装
Ubuntu下
sudo apt install doxygen
Doxygen使用graphviz来产生调用关系图
sudo apt install graphviz
使用方法
在项目目录执行
doxygen -g
来生成一个Doxyfile,修改其中的下列行改变生成目录
OUTPUT_DIRECTORY = ./doc
修改语言
OUTPUT_LANGUAGE = Chinese
之后运行
doxygen Doxyfile
即可在doc
目录下生成一个html
和latex
目录,双击html
目录中的index.html即可看到说明文档。
网友评论