Evalon4J

Java 接口文档生成工具
授权协议 MIT
开发语言 Groovy
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 黄跃
操作系统 Windows
开源组织
适用人群 未知
 软件概览

Evalon4J 是一个 Java 接口文档生成工具,直接通过命令行使用,支持Spring-MVC,JAX-RS,Swagger 2.0 等多种框架注解。同时它是付费产品 RabiAPI 使用的底层框架,通过静态分析源代码,直接生成相对应的接口文档。

和大多数开源框架不同,Evalon4J 使用 JavaParser 直接分析源代码,不需要使用任何 Gradle 或者 Maven 插件,所以使用者不会遇到任何和插件有关的烦人问题,更不会有任何版本冲突。

功能特色

  • 纯命令行工具,与项目本身零耦合,使用方便
  • 纯静态分析,无需事先编译,构建项目,极速生成
  • 支持Java泛型,递归,继承等写法
  • 支持不同框架的混合使用
  • 完全支持标准Javadoc注释
  • 完全支持枚举类型

参数说明

  • -p,指定需要生成文档的Java项目根目录,文档默认会生成在项目文件夹内
  • -o,指定导出的文档格式,目前已支持 markdown
  • -c,指定 evalon4j.json 配置文件位置,通常用不着

配置文件

你可以在项目根目录下提供一份 evalon4j.json 配置文件,运行时会自动读取。

{
  "name": "", // 项目名称
  
  "author": "whitecoms0s_", // 项目维护者
  
  "version": "1.0", // 文档版本,默认为1.0
  
  "includedServices": [], // 需要导出的服务名称或全名,白名单
  
  "excludedServices": [], // 需要过滤的服务名称或全名,黑名单
  
  "dependencies": [], // 项目依赖的源码包路径列表,(规划中)
  
  "onlyHttpApi": false, // 仅导出HTTP接口
  
  "onlyJavaApi": false, // 仅导出RPC接口
  
  "locale": "zh", // en 或 zh,会覆盖系统语言设置,没有该字段默认使用系统语言设置
}
 相关资料
  • CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档,注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境(cabal.debug配置为true)下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =

  • 我谷歌了一下,但是所有关于昂首阔步留档的例子都使用了类。我想包括接口,因为读者感兴趣的是API而不是实现。 这是我的密码: 包括所需的maven依赖项: 我的SpringBoot应用程序: 我的RestController接口 和实施 这一切都由所需的昂首阔步配置支持: 该代码可作为maven项目在https://github.com/MKhotele/spring-examples/tree/m

  • 1. 标题栏 NT_UI.setHeader(name, style); 列表 可选值 背景色 颜色 悬浮色 大小 间距 圆角 标题栏 wrapper true 标题栏-客服头像 kefuLogo true true true 标题栏-客服名称 kefuName true 标题栏-客服个性签名 kefuSignature true 标题栏-最小化按钮 min true true 标题栏-关闭按钮

  • 初始化 xn('init') 停止默认初始化 xn('stopAutoInit'); 设置访客信息 // customerinfo的可选健值见下表 xn('setCustomerInfo', JSONObject customerinfo); 参数名称 类型 备注 默认值 uid String 用户id 无 uname String 用户名称 无 userlevel String 用户等级

  • 本文向大家介绍SpringBoot整合Swagger3生成接口文档过程解析,包括了SpringBoot整合Swagger3生成接口文档过程解析的使用技巧和注意事项,需要的朋友参考一下   前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更

  • 为方便 Cocos Creator 开发者调试和接入腾讯云游戏多媒体引擎产品 API,本文为通过 Cocos Service 服务面板,接入腾讯云 GME 的接口文档。 此文档对应 GME SDK 的版本为 2.5.2。 函数原型为 GME Cocos SDK 接口文档 中定义的接口,Cocos Service 接入时设置了一个全局变量 tencentGME.tencentGMEInst,可参考示

  • ethers.js 主要包含以下4个模块 : 钱包(Wallet) ,Providers ,合约 Contract 以及 工具包 utils 。 在使用接口之前,请先确保正确 引入 ethers.js , 以下是接口列表: 钱包类 Wallet 和 签名器 Signer Wallet 签名器(Signer) 接口 提供者 Provider 连接以太坊网络 属性 获取网络 获取账号信息 获取以太坊状

  • 本文向大家介绍Python文档生成工具pydoc使用介绍,包括了Python文档生成工具pydoc使用介绍的使用技巧和注意事项,需要的朋友参考一下 在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc. pydoc是Python自带的模块,