您的位置:首页 > 编程语言 > Java开发

Java 的 Api 文档生成工具 JApiDocs 程序文档工具

2018-09-26 18:17 211 查看


JApiDocs 详细介绍

简介

JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具。最大程度地利用 Java 的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs 会帮你导出一份漂亮的 Html 文档,并生成相关的 Java 和 Object-C 相关数据模型代码,从此,Android 和 IOS 的同学可以少敲很多代码了,你也不需要费力维护接口文档的变化,只需要维护好你的代码就可以了。

一个简单的示例

特性

  1. 以一个 Controller 作为一组接口导出到一个 Html 文件中。

  2. 支持生成 Java 和 Object-C 语言的 Response 模型代码。

  3. 深度支持 Spring Boot, PlayFrameworkJFinal,不需要额外声明路由。

  4. 支持一般的 Java Web 工程,需要在相关方法添加额外的路由。

  5. 支持接口声明过时(

    @Deprecated
    ),方便的文档目录等。

  6. 支持自定义代码生成模板。

相关链接
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: