配置自定义 Javadoc 标记

要配置任何自定义标签，请使用<tags/>参数，如下所示。每个标签将由一个 <name/>、一个 <placement/> 和一个 <head/> 组成。<placement/> 应该是字母 Xaoptcmf 的组合：

  • X（禁用标签）
  • 一个（全部）
  • o（概述）
  • p（包）
  • t（类型，即类和接口）
  • c（构造函数）
  • 米（方法）
  • f（字段）

例如，使用以下配置：

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.0.1</version>
        <configuration>
          ...
          <tags>
            <tag>
              <name>todo</name>
              <!-- todo tag for all places -->
              <placement>a</placement>
              <head>To do something:</head>
            </tag>
          </tags>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>

并在一个类中使用以下 todo 标签：

/**
 * Hello world!
 *
 * @todo complete me!
 */
public class App {}

Javadoc 工具将生成以下 Javadoc：

public class App
extends Object

Hello world!

To do something:
    complete me!