码迷,mamicode.com
首页 > 其他好文 > 详细

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

时间:2015-04-04 22:22:35      阅读:743      评论:0      收藏:0      [点我收藏+]

标签:

一、引子

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

技术分享

 

技术分享

技术分享

 

 

二、工具的下载地址

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";
    }
}

输出的测试结果:

技术分享

技术分享

 

详细的步骤图片下载:http://download.csdn.net/detail/shark0017/8564357

 

参考自:

http://blog.csdn.net/liuxuezong/article/details/6713807
http://www.cnblogs.com/homezzm/archive/2013/07/02/3166602.html
http://wenku.baidu.com/link?url=XtIQOfIvSriE9_MWDqhxsPfxm9OAVpCwcwkLunBVIr7Im9FVKBy9ZB2-ZdjiSpT0obgs8Gh12NXVs02oRJ54Sj3_S_N-UleYoFAAIf29XcG
http://www.xjtudll.cn/Exp/245/

 

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

标签:

原文地址:http://www.cnblogs.com/tianzhijiexian/p/4392924.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!