如何将Javadoc的Method与Description列合并？

你遇到的是JDK 8及以上版本Javadoc默认采用的新HTML5布局——它将方法和描述分成两列显示；而你期望的是旧版的单列合并显示样式。下面提供两种可行的解决方法：

方法一：使用自定义样式表（适用于JDK 8） #

1. 找到一份旧版Javadoc的样式表（可从JDK 7或更早版本的jre/lib/javadoc.css复制，也可以直接使用网上公开的旧版样式代码），将其保存到项目的src/main/resources目录下，命名为custom-javadoc.css。
2. 修改pom.xml中的Maven Javadoc插件配置，添加样式表指定参数：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>3.5.0</version>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <!-- 指定自定义样式表路径 -->
        <additionalparam>-stylesheetfile ${basedir}/src/main/resources/custom-javadoc.css</additionalparam>
      </configuration>
    </plugin>
  </plugins>
</build>

方法二：使用-legacy参数（适用于JDK 10及以上） #

JDK 10及以后的javadoc工具新增了-legacy参数，可直接恢复旧版的单列布局，无需自定义样式表。修改pom.xml配置如下：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>3.5.0</version>
      <configuration>
        <source>1.8</source>
        <target>1.8</target>
        <!-- 启用旧版单列布局 -->
        <additionalparam>-legacy</additionalparam>
      </configuration>
    </plugin>
  </plugins>
</build>

配置完成后，重新运行mvn javadoc:javadoc命令生成文档，就能得到你期望的单列Method and Description布局了。

内容的提问来源于stack exchange，提问作者Ngu Duong