wrdoclet使用手册

wrdoclet为远程服务接口文档而生。

传统的javadoc文档虽然较为清晰的表达了内部实现类的细节,但对于远程服务的接口使用方而言,往往无法快速从javadoc中找到需要使用的接口。并且很多内部实现类的细节对于接口调用方是不需要了解的。这些内容在doc文档中的展示反而会给需要调用接口的开发人员造成阅读干扰。因此,基于自定义doclet以及taglet,开发了wrdoclet。使得服务提供方可以自动生成接口文档。同时开发了一系列组件,可以与solr、jenkins集成。最终达到接口文档自动生成、发布的目的。

本手册会详细说明注释规范,以及如何与maven集成。并且提供部署说明,介绍如何与solr、jenkins集成。

点击链接加入群【问道】:https://jq.qq.com/?\_wv=1027&k=5N484nU

results matching ""

    No results matching ""