为什么 IntelliJ IDEA 会发出警告，指出此文件 javadoc 正在悬挂？

java intellij-idea javadoc

2022-09-04 07:44:55

我正在使用IntelliJ IDEA，我试图在文件顶部添加Javadoc注释，如下所示：

/**
 * @file ProcessJson.java
 * @author Tim Sloane
 * @date 2017-05-09
 */

但是IntelliJ给了我警告“悬空的Javadoc评论”。是什么让这个评论悬而未决？我想因为它被标记为@file，它应该在文件的开头。

答案 1

如果您将 Javadoc 注释放在任何注释之后，您也会看到这一点。

例如：

@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
@SuppressWarnings({"unused", "WeakerAccess"})
/**  --> Dangling Javadoc warning.
 * This class does great and wonderful things.
 */
public class ClassThatDoesStuff {
}

相反，Javadoc 必须在所有内容之前才能收到“此文件中未发现错误”的批准印章：

/**
 * This class does great and wonderful things.
 */
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)
@SuppressWarnings({"unused", "WeakerAccess"})
public class ClassThatDoesStuff {
}

答案 2

为了以防万一，如果您有兴趣删除这个悬空的JavaDoc注释检查，则可以通过从以下位置禁用它来执行此操作：

打开首选项
导航到编辑器 -->检查
在右侧的菜单列表下，选择 Java --> JavaDoc
取消选中“悬空的Javadoc注释”