用doxygen+graphviz自动化生成代码文档（附详细教程）

最新推荐文章于 2023-08-31 17:07:45 发布

转载最新推荐文章于 2023-08-31 17:07:45 发布 · 680 阅读

一、引子

用这两个工具可以自动的遍历代码，并且产生代码文档，我们先来看看效果，然后放出这两个工具的下载地址。

二、工具的下载地址

doxygen：http://www.stack.nl/~dimitri/doxygen/download.html

graphviz：http://www.graphviz.org/

三、使用步骤

首先安装doxygen，然后解压下载好的graphviz。接着打开doxygen，按照我下面的图示进行操作就好了。

最后点run就可以了。

附上doxygen能识别的一些注释，这里仅仅是比较常用的，不是全部。为了说明清楚，我把注释和代码一起贴上。

package com.example.kale.myapplication;

/**
 * Created by Jack Tony on 2015/4/3.
 * @brief 这个类是做什么的
 */
public class TestClass {

  /// 枚举
  enum TYPE
    {
        TYPE_01,/*!< 枚举项01 */
        TYPE_02,///< 枚举项02
    };

    /**
     * 
     * <pre><b>copyright: kale</b></pre>
     * <pre><b>email: </b>developer_kale@qq.com</pre>
     * <pre><b>company: </b>http://www.cnblogs.com/tianzhijiexian/</pre>
     * <pre><b>All rights reserved.</b></pre>
     * @see 参考项 http://www.cnblogs.com/tianzhijiexian/
     * @brief 方法的简单说明
     * @author 作者的信息
     * @date 2011/8/24 8:37:56
     * @version 0.1
     * @retval c 描述返回值的类型
     * @note 注解，可以是详细的注解
     * @remarks   备注事项（remaks）
     * @attention 注意事项(attention)
     * @warning 警告信息
     * @param a 参数a的说明
     * @param b 参数b的说明
     * @return 本函数返回执行结果
     * 
     * @throws Exception
     */
    public String testFunction(int a, String b)  throws Exception{
        return "hello world";
    }
}