Windows下用Doxygen轻松为c,c++,java编写源码文档、协助源码分析

一、缘起

为源码编写文档是件累人的事，看别人的源码更是一件累人的事。

看别人的源码时，用javadoc、doxygen等文档生成软件生成一个说明，免去反复的Go to definition.

之前用过大名鼎鼎的JavaDoc(只能用于Java)，后来用doxygen(可用于c、c++、java)，好用，

 

但有两个问题：

1，doxygen 有很多参数，记不住,打命令行也累。
2，doxygen 对注释有要求，有很多下载来的源码，注释风格不符合要求。

想写一个向导，于是便有了我的WinDoxygen。


二、DIY动手

用C++ Builder 6写的，四步搞定文档编写：

1,选择源码目录


2,选择文件类型


3,修改注释风格
  WinDoxygen会自动帮你分析源码的注释风格是否正确。如图，都不正确。



  点击 "Change Comment Style"，WinDoxygen会自动把源码注释风格修改OK。

4、设置几个简单的选项: 项目名称、版本号、输出格式(html,chm,rtf)等

   如果你是doxygen的专家，也可以用 detailed options 进行详细设置



5、生成文档
   此时将调用 doxygen.exe 生成文档



6、看看结果：这是个自动生成的.chm文件，OK，好用吧。


7. 把它作为工具放在IDE的Tools菜单中，在写程序时，可立即生成文档看一看，很方便。

    设置时，将源码目录名作为命令行参数即可

    比如：在VS.net中，点菜单 工具->外部工具->添加，定义如下：

OK，打开任何项目都能用了。

用于分析开源项目的代码也有用。


三、源码和安装包，我发在 sourceforge上了

https://sourceforge.net/projects/windoxygen/files/

欢迎拍砖.

BLOG主页: http://blog.csdn.net/c80486