主页 / coding / 问题 / 77640904
Accepted
PatPanda
Asked: 2023-12-12 00:12:29 +0800 CST

警告：带有 javadoc 的 java 21 中的字段没有 @param

  • 772
  • 我想要实现的目标：

为非常简单的 java 21 记录生成 javadoc。

  • 我尝试了什么：

我有这么简单的记录：

/**
 * The type Some record.
 */
public record SomeRecord(String someField) {
}

和这个pom：

<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>
    </configuration>
</plugin>

我正在运行这个 Maven 命令：

mvn clean install site -U javadoc:javadoc
  • 问题：

100% 可重复，我明白了：

SomeRecord.java:6: warning: no @param for someField
[WARNING] public record SomeRecord(String someField) {
[WARNING] ^
  • 问题：

这段代码有什么问题？这是什么@param？我记得Spring的@Param，但是@param（小写？）如何在没有javadoc的情况下正确生成？

java

1 个回答

  1. Best Answer

    @param在 Javadoc 上下文中，称为 Javadoc 标记（有时称为 JavaDoc 块标记），它用于记录将使用的特定参数（即，它在域中构成什么）。这与 Spring无关@Param。

    甲骨文说：

    文档注释是用 HTML 编写的，并且必须位于类、字段、构造函数或方法声明之前。它由两部分组成——描述和块标签。

    对于warning: no @param for someField，它只是说，您没有该参数的描述（应该由@param, 在 JavaDoc 中创建）someField。

    只需添加：

    /**
 *
 * The type Some record.
 * @param someField here goes your description of someField
 */
public record SomeRecord(String someField) {
}

    最后，请注意，该javadoc工具会警告您它需要一些块标签但未找到它们的所有位置。

    • 2

相关问题