基于 Java 的代码注释 XDoc-Java

MIT
Java
跨平台
2018-07-13
风里的叶子

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的副作用: 会让你接口注释写得更加严谨

的码云指数为
超过 的项目
加载中

评论(2)

水晶之夜2017
水晶之夜2017
如果返回结果能够基于程序自动响应的结果,而不是手动填写,就更好了,更省事一些。
那么轻的信任
那么轻的信任
如果是一个对象 里面的字段也能解析吗?

暂无资讯

暂无问答

基于新浪云(SAE)的免费在线Office

XDOC Office部署到了SAE中,基于此可以为大家提供一个免费在线的Office软件: http://xdoc.sinaapp.com XDOC Office是基于Java的,如果本地没有Java虚拟机,会自动安装。XDOC Office的核心程...

2013/07/03 23:07
170
0
PDF生成进入基于Web服务的模板时代

PDF在版式文档中的王者地位不可撼动。我们有多种生成PDF的程序库:FPDF(PHP)、IText(Java)、PDFsharp(.NET)等。在不同语言环境下需要选择不同的程序库,通过API方式调用生成PDF,效率低...

2015/08/26 21:16
374
0
云报表XDOC发布了

  第一款公有云报表平台XDOC发布了。XDOC云报表部署在新浪云(SAE)中,免费给大家开放。   XDOC云报表具有以下特点: ● 公有云部署,随时随地访问 ● 内容格式丰富:段落、文字、图形、...

2013/09/08 21:57
96
0
纯Java文档阅读器(word、pdf等)

XDocViewer是一个纯Java的文档阅读器组件,可以方便的集成到Java应用中(也可以集成到Web应用中),它有如下特点: 1、免费 2、支持的文档格式丰富:MS Office文档(doc、docx、ppt、pptx、x...

2012/01/17 22:33
2.9K
0
在Java中生成专业的公文文档

在Java中生成专业的公文文档

2015/04/08 17:24
702
2
开源中国新闻转博客图片

XDOC Office是一个基于Java的在线的Office http://office.xdocin.com,与普通Office相比,最大的特点是每一个XDOC文件都是一个应用,将开源中国的新闻转为博客图片就是一个应用,使用很简单,...

2013/07/13 22:32
136
0
XDOC云服务-简单参数报表

设计 在浏览器中输入下面的链接,打开XDOC设计器 http://www.xdocin.com/xdoc?_func=builder 由于XDOC设计器使用了Java技术,加载过程中可能被浏览器拦截,请接受后继续。 打开后的界面如下图...

2014/04/27 12:24
1K
0
几种解析Word文档的Java类库比较

这两天因为工作的原因,需要根据模板生成word文档,因为需求有些特殊,为了选择最好的解决方案,所以尝试了很多种类库,今天分享一下。 POI 推荐指数:⭐ 因为之前做过EXCEL的解析,所以我首...

2018/07/18 18:00
260
1
findBugs 快速开始

1.快速入门 如果您在Windows系统上运行FindBugs,请双击该文件%FINDBUGS_HOME%\lib\findbugs.jar以启动FindBugs GUI。 在Unix,Linux或Mac OS X系统上,运行该$FINDBUGS_HOME/bin/findbugs 脚...

2018/06/30 23:14
55
0
Java实例教程

Java当前日期/时间 Java将字符串转换为日期 Java当前工作目录 Java正则表达式 Java立方体 编译并执行Java Online 用于连接两个数组的Java程序 Java添加两个数组 字符串的Java字符 Java多字符...

2018/11/02 10:48
19
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部