Doxygen是一个开源软件,它类似javadoc,能够根据源代码和源代码中特定格式的注释,生成文档和UML图(如果要生成UML图,需要下载可选组件Graphviz)的。多平台支持(Linux, Windows, Mac),多编程语言支持(C++, C, Java, Python, Fortran, VHDL, PHP, C#等等)。
使用方法:
首次使用,先要制作一个Doxyfile,也就是Doxygen的工程文件,有了Doxyfile后,想生成文档就简单多了,只需在Doxywizard(即Doxygen的GUI程序)中File--->Open,选择已有的Doxyfile,然后选择Run doxygen即可。
如果代码里面有中文,还有两个位置要设置:
DoxywizardExpertProject | DOXYFILE_ENCODING: UTF-8改为gbk |
DoxywizardExpertInput | INPUT_ENCODING: UTF-8改为gbk |
或者更直接的,把Doxyfile用Ultraedit打开,直接去改两个配置项,也成。
其他一些我偏好的配置
DoxywizardExpertDot | UML_LOOK: YES CALL_GRAPH: YES CALLER_GRAPH: YES |
注意:也可以直接利用命令提示符(cmd)来利用已有的Doxyfile来生成文档,只需在cmd中执行“doxygen Doxyfile”(可能需要完整路径,除非是在当前文件夹下)