Android 警告：悬空Javadoc注释

自从我更新了我的Android Studio（2.3.1）和构建工具（2.3.1），我收到了警告

警告：悬空Javadoc注释

对于这样的评论

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

如您所见，我使用javadoc风格的注释进行链接和其他注释。我想知道是否有其他的评论选择有链接功能

---

谢谢。

调用方法

setNameText

时，您似乎正在使用Javadoc注释。将插入以上的类声明、方法声明或字段声明

---

如果在调用该方法时只需要一条注释，请使用单行注释：

//根据{@link FORMAT\u name}获取格式化名称

只需将“悬空Javadoc注释”替换为块注释。

您可以在“文件设置编辑器检查Java Javadoc问题悬空Javadoc注释”页面中将其关闭.

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

---

要减轻该警告，请始终在方法中以/*而不是/**开头您的注释

在我看来，这个注释的正确位置似乎是在方法getFormattedName（）旁边，因为您的注释解释了该方法的功能，而不是您调用它的原因。

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

但是使用一行注释时，使用{@link FORMAT\u NAME}不会像使用JavaDoc注释那样进行链接。我在Android Studio IDE上对此进行了检查。@Dhunju_希望_了解到这一点，但事实是，您放置注释的位置对于javadoc注释来说是不正确的。@nasch，同意。您提到的注释应该是该方法的常规javadoc注释。这是因为，comment描述了该方法正在做什么，而代码注释应该描述——为什么要调用该方法而不是其他方法。那么，您不能使用{@link}——它只在javadocs中由IDE索引。@Ev0oD如果您想使用{@link}，最好的选择可能是禁用AS检查中的“悬空Javadoc注释”报告。然后你可以在任何地方使用“Javadoc注释”，但这是不推荐的。警告是用来帮助提高代码质量的，而不仅仅是关闭它们。正如其他答案所解释的，这个警告背后有一个原因。你可能关闭警告的唯一情况是，当你有令人信服的理由认为警告是不必要的，我认为这里没有这种情况。如果你真的认为这个警告没有必要，你应该在回答中解释你的理由。Thanks@pedram巴希里，你能指出这个警告的原因吗？我认为这样使用javadoc注释的唯一错误是它打破了惯例。我改变了问题以反映这段代码的功能。我在这里举了一个简单的例子，但在很多情况下，我需要放一个长的注释来描述代码块的功能。而且我经常需要使用@link链接到代码中的其他地方，这样就更容易跟踪/理解注释了。请看“此标记[@link]在所有文档注释中都有效：概述、模块、包、类、接口、构造函数、方法和字段”。这是正确的格式{@link package.class#member label}，非常完美！但是当我使用带有一行注释的{@link}进行测试时，它没有链接：（。另外，spec表示任何类型的“文档”注释。