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

一. 痛点

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

二. 基于注释生成文档

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

https://github.com/easycodingnow/genDocgithub.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函数

解析规则：

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

文档搜索功能：

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

kibana 查看索引库中文档个数_两款超好用的Kubernetes实时日志查看工具
通常情况下,Kubernetes 环境下的应用日志都需要通过日志系统来进行收集,比如:Filebeat + ElasticSearch + Kibana 的组合来实现.虽然这一组合的功能相当强大,但是 ...
c++修复工具_几款平价又好用的U盘修复工具分享
阅读本文前,请您先点击上面的蓝字,再点击"关注",这样您就可以免费收到最新内容了.每天都有分享,完全是免费订阅,请放心关注.1111111111111111111111111111 ...
数据来源渠道及采集工具_几款简单好用的爬虫抓取数据采集工具
新朋友点上方蓝字"Office交流网"快速关注 1. 火车头采集器火车采集器我们也一直在用,是老牌的采集工具了.它不仅可做抓取工具,也可以做数据清洗.分析.挖掘已经可视化等工作. ...
java code review 工具_两款好用的代码Review工具 | 学步园
最近团队内部呼吁代码质量的声音越来越高,项目组引入了代码Review机制.上次我由于不了解主站URL替换的规则,险些造成客户端图片读取错误,而代码Review则有助于帮我们发现代码潜在的问题. 主讲的 ...
java word 文档合并_如何通过java将多个word文档合成一个wor
展开全部国内有个免费32313133353236313431303231363533e78988e69d8331333431356133的jar(Free Spire.Doc for Java),可 ...
java 集成开发工具_最好的Java开发人员测试和集成工具
java 集成开发工具通过从您的应用程序学习企业APM产品,发现更快,更有效的性能监控. 参加AppDynamics APM导览! 无论您是刚刚起步还是已经从事了一段时间,使用正确的工具进行编程都可 ...
dicom标注工具_四款常用的医学图像标注工具
ITK-SNAP app主页链接:ITK-SNAP ITK-SNAP是一款可应用于分割3D医学图像的软件.来自于宾夕法尼亚大学图像计算与科学实验室(PICSL)和犹他大学成像研究所(SCI)长达十年的 ...
java基本语句回文数实验_实验二 java基本数据类型与把持语句.doc
实验二 java基本数据类型与把持语句.doc 还剩 4页未读, 继续阅读下载文档到电脑,马上远离加班熬夜! 亲,喜欢就下载吧,价低环保! 内容要点: 5System.out.println(num ...
java反编译工具_如何保护Java程序才能防止Java反编译
简介:Java是一种跨平台的.解释型语言.Java 源代码编译中间"字节码"存储于class文件中.Class文件是一种字节码形式的中间代码,该字节码中包括了很多源代码的信息,例如 ...

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

一. 痛点

二. 基于注释生成文档

三.如何使用

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

最新文章

热门文章