java 接口文档工具_一款Java基于注释的接口文档生成工具

一. 痛点

• 你还在手动维护接口文档嘛，花一个下午不停的复制粘贴代码里面的注释
• 接口字段变动，还得去更新文档，更新不及时导致文档不同步
• 或者你使用了swagger之类的基于注解，依靠运行时的文档工具，看着swagger繁多的注解定义，满屏幕的文档注解，你的强迫症有没有发作

二. 基于注释生成文档

genDoc 是一款基于注释，完全没有代码入侵，静态解析的文档生成工具。

https://github.com/easycodingnow/genDoc​github.com

优势和亮点：

• 一键生成，只需完善注释
• 支持泛型解析，参数智能解析
• 不入侵代码，代码即文档，完善代码的同时也生成文档，增加了代码可读性，解决了程序员不爱写注释的习惯
• 兼容swagger，之前接入swagger的项目，可以不做改动迁移(swagger只支持部分常用注解，如有需要支持部分，请提issue)

使用场景：

• 目前支持的web类型有spring mvc，如果你的项目不是基于spring mvc 请联系我
• 支持rpc接口（扫描特点包下面的接口）文档生成

三.如何使用

• git clone https://github.com/easycodingnow/genDoc.git
• 打开gendoc-demo/gendoc-demo-example/src/main/java/com/easycodingnow/demo/example/Main.java 类

private static void genDoc(){

        String sourcePath = ""; //源代码目录
        String outPath = ""; //生成的文件输出目录
        GenDoc.gen(sourcePath, outPath);

    }

• 填写要扫描的源代码目录sourcePath
• 填写生成文档的输出目录outPath
• 运行main函数

解析规则：

对象类型点击打开效果（支持嵌套类型的打开）：

文档搜索功能：