Evalon4J Java接口文档生成工具

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，会覆盖系统语言设置，没有该字段默认使用系统语言设置
}