基于 Java 的代码注释 XDoc-Java

• 授权协议: MIT
• 开发语言: Java
• 操作系统: 跨平台
• 软件首页: https://gitee.com/treeleaf/xDoc
• 软件文档: https://gitee.com/treeleaf/xDoc

软件介绍

XDoc, 是基于Java语言编写,提供将Java方法上的注释转成接口文档的工具．不同于sun doc生成的Java文档, XDoc只专注于对外接口层的文档转译, 基于原有的sun doc注解,加上扩展的一些,为使用者提供了更加丰富的注释功能,让更加快捷的生成接口文档,不需要再打开word等文档,按照繁琐的方式,将接口文档一点点加上去.

XDoc 快速文档构建框架

• 基于java注释生成接口文档

• 注释支持扩展

• 接口框架支持扩展

• 默认支持markdown和离线/在线html等格式的文档

• 默认支持spring mvc规范

• 默认支持spring-boot直接内嵌启动

XDoc提供了基于Spring MVC/Boot框架的接口文档生成, 同时针对其它框架,也提供方便扩展的接口, 同时支持集成在应用里直接通过页面访问的在线接口(ps:附带测试请求的按钮), 以及离线的接口文档;

支持HTML和markdown格式

Demo:

/**
 * 查询用户状态,该接口只返回用户的状态
 *
 * @param username 用户名|String|Y
 * @resp status 状态,1-启用,0-禁用|Integer|N
 * @respbody {"status":1}
 * @title 用户状态查询接口
 * @see User
 */
@RequestMapping("status")
@ResponseBody
public User status(String username) {
    User u = new User();
    u.setStatus(1);
    return u;
}

生成的接口文档:

XDoc: 让写接口文档从未如此简单

使用XDoc的副作用: 会让你接口注释写得更加严谨

本文地址：https://codercto.com/soft/d/18379.html