Doxygen

doxygen

• Doxygen: Doxygen

• 在Donwload中，可以下载manual.pdf。

说明

Doxygen ，是一个从C++源代码注释生成文档的标准的工具。也支持其他流程语言，例如：C，java，python，VHDL等。

可以从以下三个方面取得帮助：

• 生成一个在线文档（HTML）或者/并且生成一个离线参考手册（Latex）。还支持生成输入RTF，超链接PDF，压缩HTML和Unix参考手册。

• 你可以配置doxygen，可以从没有注释的源文件中抽取代码结构。这个在大型源码工程中是非常有帮助的。

• 还可以使用doxygen生成普通文档。

使用

• 现在ubuntu上安装doxygen

• doxygen -g Doxygen.config

  Configuration file 'Doxygen.config' created.
  ​
  Now edit the configuration file and enter
  ​
    doxygen Doxygen.config
  ​
  to generate the documentation for your project

  • 生成了config文件，然后可以编辑config文件。

  • 修改：

    EXTRACT_ALL            = YES
    EXTRACT_PRIVATE        = YES
    EXTRACT_STATIC         = YES
    HAVE_DOT               = YES，这个配置假设dot工具是可得到的，工具是Graphviz，默认就是YES，所以系统中需要安装Graphviz
    UML_LOOK               = YES
    DOT_PATH               = /usr/bin/graphml2gv
    RECURSIVE              = YES

• doxygen Doxygen.config

  • 会在当前目录下生成html和latex目录

  • 打开html/index.html

plantUML

• 从官网上下载plantuml.jar，放到本地/bin目录下

• 设置Doxygen.config

  PLANTUML_JAR_PATH      = /home/fyl/bin/plantuml.jar

• 代码中，要有使用plantUML描述流程的语言。然后就可以生成对应的UML图了。