阿超 > javadoc @apiNote、@implSpe、@implNote不识别问题

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

2022-07-31

java

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

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

image-20220731172158978

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

手动配置tags即可

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<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>