基于java注释生成接口文档

基于java注释生成接口文档

基于java注释生成接口文档-对代码无侵入,无需注解,纯代码注释,支持SpringWeb/SpringBoot,JFinal在线和离线文档

XDoc 基于Java注释的接口文档工具

• 基于java注释生成接口文档-对代码无侵入,无需注解,纯代码注释
• 支持SpringWeb, SpringBoot, JFinal
• 文档输出格式支持markdown和离线/在线html等

为何使用XDoc?

• 减少外部接口文档的另外编写,在编码过程就一起完成,减少外部维护工作量
• 修改代码时,少掉翻看外部接口文档的过程,直接看代码注释
• 接口文档同版本管理一起,可方便回退以及多环境多版本
• 难道标准的注释不应该作为企业项目的必须规范吗?如果你的规范里没有接口这块的,那么,还不补上?如果补上的还能帮你生成文档,何乐而不为?

如何使用?

<!--加入maven依赖-->
<dependency>