javadoc4openapi-maven-plugin文档工具
javadoc4openapi 使用java注释代替swagger注解,生成openapi(swagger3)文档,代码零侵入.
javadoc4openapi-maven-plugin是其maven插件,项目编译时在resources下生成javadoc4openapi.yaml文档文件.
目前支持SpringMVC/SpringBoot
使用条件
依赖源码,项目在编译时需要打源码包,Maven配置如下
<!-- Source -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.2.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
如何使用
目前还没有上传到Maven仓库,需要手动在本地install一下再引用.
Maven插件配置如下
<plugin>
<groupId>org.springrain</groupId>
<artifactId>javadoc4openapi-maven-plugin</artifactId>
<version>0.0.1</version>
<configuration>
<includes>
<!--需要加载分析的maven依赖源码包,本项目的groupId默认添加-->
<!--可以添加groupId或者groupId:artifactId-->
<!--
<include>org.springrain</include>
-->
</includes>
</configuration>
<executions>
<execution>
<!--如果不需要在执行编译时启动,则将phase注释掉-->
<phase>compile</phase>
<goals>
<goal>openapi</goal>
</goals>
</execution>
</executions>
</plugin>
评论
Sphinx 文档工具
Sphinx简单来说,是一个文档生成工具,用于把reStructuredText格式的源文件生成诸如HTML,PDF,LaTex一类的格式。编辑者无须亲自处理文本的格式,程序会自动根据源文件里的设置产
Sphinx 文档工具
0
JSimpleDocJava文档工具
JSimpleDoc是一个用来根据程序源码生成文档的工具,类似JavaDoc,能自动保持跟源码文件的同步。支持PHP、Java编程语言。
JSimpleDocJava文档工具
0
YardRuby 文档工具
YARD是一个Ruby文档生成工具。它使用户能够生成一致的、可用的文档,这些文档可以非常容易地导出为多种格式,并且还支持扩展自定义Ruby结构,如自定义类级定义。特点:1.RDoc/SimpleMar
YardRuby 文档工具
0
eLyXerHTML文档工具
eLyXer是一个将lyX文档转成HTML文档的工具,采用Python开发。使用方法:$elyxerdocument.lyxpage.htmlPython.exeelyxerdocument.lyxp
eLyXerHTML文档工具
0