前言
程序员一直以来都有一个烦恼，只想写代码，不想写文档。代码就表达了我的思想和灵魂。Pytho提出了一个方案，叫docstrig，来试图解决这个问题。即编写代码，同时也能写出文档，保持代码和文档的一致。docstrig说白了就是一堆代码中的注释。Pytho的docstrig可以通过help函数直接输出一份有格式的文档，本工具的思想与此类似。
代码即文档Apiggs是一个非侵入的RestDoc文档生成工具。工具通过分析代码和注释，获取文档信息，生成RestDoc文档。
有这样一段代码/** * Buildig a RESTful Web Service * 来自sprig的官方示例:https://sprig.io/guides/gs/rest-service/ */@RestCotrollerpublic class GreetigCotroller { private static fial Strig template = "Hello, %s!"; private fial AtomicLog couter = ew AtomicLog(); /** * Web Edpoit greetig * @param ame who is this * @retur */ @RequestMappig("/greetig") public Greetig greetig(@RequestParam(value="ame", defaultValue="World") Strig ame) { retur ew Greetig(couter.icremetAdGet(), Strig.format(template, ame)); }}运行插件gradle 运行 task:Tasks/documetatio/apiggs
mave运行 compile
生成文档在编译目录下生成apiggs文件夹，并生成三个文件：
1..jso文件，可直接导入postma
1..adoc文件，Asciidoc源文件
1..html文件，源文件渲染结果，效果如下图
查看更多信息：Wiki
评论