javadoc @apiNote、@implSpe、@implNote不识别问题

简介: javadoc @apiNote、@implSpe、@implNote不识别问题

在逆风里把握方向,做暴风雨中的海燕,做不改颜色的孤星。——余光中

我们使用maven-javadoc-plugin进行生成javadoc时,发现没有识别jdk8新标签

解决方式见:https://github.com/nipafx/demo-javadoc-8-tags/blob/master/pom.xml?ts=4#L110-L133

手动配置tags即可

<build>
    <plugins>
        <!-- Maven编译插件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>${maven.compiler.source}</source>
                <target>${maven.compiler.target}</target>
                <compilerArgument>-Xlint:unchecked</compilerArgument>
            </configuration>
        </plugin>
        <!--junit5依赖-->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version>
            <configuration>
                <testFailureIgnore>true</testFailureIgnore>
            </configuration>
        </plugin>
        <!-- Javadoc -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.4.0</version>
            <configuration>
                <additionalOptions>-Xdoclint:none</additionalOptions>
                <tags>
                    <tag>
                        <name>apiNote</name>
                        <placement>a</placement>
                        <head>API Note:</head>
                    </tag>
                    <tag>
                        <name>implSpec</name>
                        <placement>a</placement>
                        <head>Implementation Requirements:</head>
                    </tag>
                    <tag>
                        <name>implNote</name>
                        <placement>a</placement>
                        <head>Implementation Note:</head>
                    </tag>
                    <tag>
                        <name>param</name>
                    </tag>
                    <tag>
                        <name>return</name>
                    </tag>
                    <tag>
                        <name>throws</name>
                    </tag>
                    <tag>
                        <name>since</name>
                    </tag>
                    <tag>
                        <name>version</name>
                    </tag>
                    <tag>
                        <name>serialData</name>
                    </tag>
                    <tag>
                        <name>see</name>
                    </tag>
                </tags>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
相关文章
|
Java
使用ideal 生成JavaDOC文档
使用ideal 生成JavaDOC文档
62 0
|
1月前
|
IDE Java API
Javadoc的讲解使用
本文介绍了Javadoc工具的使用方法和常用标签,通过示例代码展示了如何为Java代码添加文档注释并使用Javadoc命令生成HTML格式的API文档。
15 0
|
5月前
|
Java API
蓝易云 - Javadoc生成编码配置
这将为"MyJavaFile.java"生成API文档,并将其存放在"doc"目录中。
22 1
|
6月前
|
Java 编译器 计算机视觉
javap的使用--常用: javap -c -v 类名--javadoc 标签--javadoc 工具软件识别以下标签:
javap的使用--常用: javap -c -v 类名--javadoc 标签--javadoc 工具软件识别以下标签:
39 0
|
Java API
JavaDoc
JavaDoc命令是用来生成自己API文档的,将写好的程序放在生成的文档中 参数信息 @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 package com.wyd.base
JavaDoc
|
Java Android开发
javaDOC生成
javaDOC生成
106 0
|
编译器 C语言 Swift