文件名称:dockit:基于javadoc的Markdown文档生成工具。Markdown document generator base on javadoc
文件大小:28KB
文件格式:ZIP
更新时间:2024-06-18 04:49:10
Kotlin
Dockit
:loudly_crying_face: :loudly_crying_face: 别光fork啊,麻烦点个star:loudly_crying_face:
Dockit 是一个通过javadoc生成markdown文档的生成工具。
不依赖于@RequestMapping注解,直接根据javadoc中是否有@title来生成接口文档
可应用于dubbo项目中
若需要dockit生成文档,则需要在类的javadoc中加入@dockit
如:
/**
* @author ysdxz207
* @date 2018-08-02
* @dockit 阿福接口
*/
生成dockit目录结构如下:
dockit - 阿福接口 - 阿福列表接口.MD
若不需要按目录生成,则可以设置插件参数singleOutDir=true
pom.xml:
【文件预览】:
dockit-master
----.gitignore(268B)
----src()
--------main()
----LICENSE(11KB)
----pom.xml(8KB)
----README.md(4KB)
----example()
--------afu.md(4KB)