警告:悬空Javadoc评论

Question

自从我更新了我的Android Studio(2.3.1)和构建工具(2.3.1)后,我收到了警告,

警告:悬空Javadoc评论

对于评论,

/** set name with format, {@Link FORMAT_NAME} **/
setNameText(getFormattedName(FORMAT_NAME));

如您所见,我使用javadoc样式注释进行链接和其他.我想知道是否有其他评论替代品具有链接功能.

谢谢.

Answer 1

看起来您在调用方法时使用的是Javadoc注释setNameText.Javadoc注释将插入到类声明,方法声明或字段声明之上.

如果您只是在调用方法时想要注释,请使用单行注释:// get formatted name based on {@link FORMAT_NAME}.

但是对于单行注释，使用 {@link FORMAT_NAME} 不会像使用 Javadoc 注释那样链接。我在 Android Studio IDE 上检查了这个。 (5认同)
@Dhunju_likes_to_Learn 可能是这样，但事实仍然是，您放置该评论的位置是 javadoc 评论的错误位置。 (2认同)

Answer 2

您正在使用以 /** 开头的 Javadoc 格式，而不是以 /* 开头的块注释格式。

为了减轻该警告，请始终使用 /* 而不是 /** 在方法中开始您的注释。

Answer 3

如果它帮助其他人，请确保您没有在方法/类定义和您对该定义的任何注释之间偷偷摸摸您的 JavaDoc。