javadoc-plugin

简介: javadoc-plugin

掉头一去是风吹黑发,回首再来已雪满白头。——余光中

我们可以使用maven-javadoc-plugin生成javadoc

<!-- Javadoc -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.4.0</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

但如果我们有自定义标签或者新版标签,我们需要配置一个additionalOptions-Xdoclint:none

<!-- Javadoc -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.4.0</version>
    <configuration>
        <additionalOptions>-Xdoclint:none</additionalOptions>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

否则会因为MavenReportException: Error while generating Javadoc而中断生成

相关文章
|
Java
使用ideal 生成JavaDOC文档
使用ideal 生成JavaDOC文档
62 0
|
1月前
|
Java Maven Spring
用javadoc生成springboot的文档
本文介绍了生成Spring Boot项目JavaDoc文档的步骤,包括创建项目、在pom文件中添加maven-javadoc-plugin插件配置、执行Maven命令生成文档,以及查看生成的文档结果。
16 0
用javadoc生成springboot的文档
|
1月前
|
IDE Java API
Javadoc的讲解使用
本文介绍了Javadoc工具的使用方法和常用标签,通过示例代码展示了如何为Java代码添加文档注释并使用Javadoc命令生成HTML格式的API文档。
15 0
|
Java API
JavaDoc
JavaDoc命令是用来生成自己API文档的,将写好的程序放在生成的文档中 参数信息 @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 package com.wyd.base
JavaDoc
|
Java Android开发
javaDOC生成
javaDOC生成
106 0