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

Posted ios9

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java 的 Api 文档生成工具 JApiDocs 程序文档工具相关的知识,希望对你有一定的参考价值。


JApiDocs 详细介绍

简介

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

一个简单的示例

特性

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

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

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

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

  5. 支持接口声明过时(@Deprecated),方便的文档目录等。

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

相关链接


以上是关于Java 的 Api 文档生成工具 JApiDocs 程序文档工具的主要内容,如果未能解决你的问题,请参考以下文章

扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!

扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!

DAY2-JAVA

.Net有没有自动生成WebAPI接口的网站或工具??

Java文档注释

Java语言概述-注释与API文档等