如何消除Spring Boot配置类Javadoc默认构造器注释警告

问题场景 #

执行Maven命令 mvn clean install site -U javadoc:javadoc 时，Spring Boot的@Configuration类会因默认构造器缺少注释触发警告：

use of default constructor, which does not provide a comment

需求：不手动编写完整构造器的前提下消除该警告。

方案1：给配置类添加抑制警告注解 #

直接在@Configuration类上添加@SuppressWarnings("javadoc")，让Javadoc工具忽略该类的构造器注释警告。

修改后的配置类代码：

/**
 * This is Some Configuration. There is some meaningful doc here.
 */
@SuppressWarnings("javadoc")
@Configuration
public class SomeConfiguration {

    @Value("${my.host}")
    private String host;

    /**
     * span exporter.
     * This is used to send traces to the host.
     * Some more meaningful doc here.
     *
     * @return the span exporter
     */
    @Bean
    public SpanExporter spanExporter() {
        return OtlpGrpcSpanExporter.builder().setEndpoint(host).build();
    }
}

方案2：配置maven-javadoc-plugin忽略构造器注释检查 #

在pom.xml的maven-javadoc-plugin配置中，添加Javadoc参数，忽略指定类型的注释检查。

修改后的pom配置片段：

<reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <configuration>
                <outputDirectory>target/javadoc</outputDirectory>
                <reportOutputDirectory>target/javadoc</reportOutputDirectory>
                <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
                <!-- 忽略缺失注释的检查，JDK 10+可使用更精确的 -Xdoclint:all,-missing:constructor 仅忽略构造器 -->
                <additionalparam>-Xdoclint:all,-missing</additionalparam>
            </configuration>
        </plugin>
    </plugins>
</reporting>

方案3：在类注释中补充默认构造器说明 #

在类的Javadoc注释中直接说明默认构造器的用途，让Javadoc识别该构造器的注释信息。

修改后的类注释：

/**
 * This is Some Configuration. There is some meaningful doc here.
 * <p>
 * 默认构造器，供Spring框架用于依赖注入。
 */
@Configuration
public class SomeConfiguration {
    // 原有代码保持不变
}

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