0. 这个玩意儿是干嘛的
类似javadoc,根据源代码和源代码中特定格式的注释,生成文档和UML图的。多平台支持(Linux, Windows, Mac),多编程语言支持(C++, C, Java, Python, Fortran, VHDL, PHP, C#等等),多语言支持,小,而且挺好用。
1. 下载
Doxygen,目前的版本是1.5.6
http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
Graphviz,用来生成UML图,可选组件
http://www.graphviz.org/Download..php
2. 使用
首次使用,先要制作一个Doxyfile,也就是Doxygen的工程文件,然后运行就搞定。以后再想生成同一个项目的文档(比如说源代码更新之后),Load这个文档就行了。这个Doxyfile也不难作,用wizard走一下,然后保存即可。
总的来说使用起来很简单,不过如果代码里面有中文,还有两个位置要设置:
DoxywizardExpertProject | DOXYFILE_ENCODING: UTF-8改为gbk |
DoxywizardExpertInput | INPUT_ENCODING: UTF-8改为gbk |
或者更直接的,把Doxyfile用Ultraedit打开,直接去改两个配置项,也成。
其他一些我偏好的配置
DoxywizardExpertDot | UML_LOOK: YES CALL_GRAPH: YES CALLER_GRAPH: YES |
呃,提醒自己不做IT之前还是要摸些东西留作纪念的,譬如GUI,譬如UML…
有选择的对某些领域进行遗忘的成果十分的喜人,总觉得这些东东在两个月前花5分钟应该是能看出个大概来的。
/*!
* @ingroup
* \class
* \brief
*
*/
//!
嗯 这个以前用的很多
不过提取出来的文档最后都没人管…