Android Studio 中的 Javadoc @link 引用答案

【问题标题】：Javadoc @link references in Android StudioAndroid Studio 中的 Javadoc @link 引用
【发布时间】：2014-12-15 11:04:32
【问题描述】：

我正在尝试使用 Android Studio 生成一些 Javadocs。我指的是{@link #method()} 与链接在同一类中的一个方法，但我仍然从Javadoc 收到reference not found 错误。我可能遗漏了一些非常愚蠢的东西，但我无法弄清楚它是什么。有没有其他人遇到过同样的问题？

【问题讨论】：

已提交错误报告 - 似乎类似 - 虽然它与自动完成有关，但您可能会在那里获得一些额外信息：code.google.com/p/android/issues/detail?id=67855

标签： java android-studio javadoc

【解决方案1】：

在 Android Studio 中的 javadoc 注释中，尝试输入 {@，然后点击 ctrl+space 以查看弹出的内容...

选择link后，点击空格。

现在再次尝试 ctrl+space 以获得所有可能类的列表。

要仅引用当前类中的方法/数据，请键入 #，然后键入 ctrl+space 以查看列表可能是你想要的。

别忘了确保括号是闭合的！

【讨论】：

以及如何引用 XML 文件？类似{@link res/custom_strings.xml}
@Rexxar：不知道，但这是一个非常好的问题！来吧，让它成为一个单独的问题，并在此处发布链接以供其他人使用。
感谢您的理解和鼓励！这是：stackoverflow.com/questions/41433645/…
您是否知道如何在 cmets 中链接 build.gradle 文件？
@RahulKhurana 这是一个非常好的问题！你应该提出你自己的问题。这样其他人就可以轻松找到它。

【解决方案2】：

Android Studio中javaDoc lint标签的格式为：

{@link package.class#member label}

这里有更多关于javaDoc tags的信息。

【讨论】：

因为它不能解决为什么这些出现的问题。长解释是，当您在 android studio 中扩展视图并覆盖方法并选择为覆盖方法添加 javadoc 时，它们中的链接不包括链接中的包名称。并且 android studio 对此感到很满意，您必须通过一些搜索和替换来手动修复它们。因此，例如看到 android.view.View#View(Context, AttributeSet, int, int) 被导入到您的视图扩展类中，参见#View(Context, AttributeSet, int, int)，您需要手动修复。跨度>
您是否知道如何在 cmets 中链接 build.gradle 文件？

【解决方案3】：

我不知道是否有人还在为此苦苦挣扎，但如果你还在苦苦挣扎，而 {@link 没有工作，那么请确保你的评论块看起来像这样

/**
* {@link 'your reference'
*/

确保注释块以两个 * 开头，而不是一个，显然，这对我在 android studio 中有效。

【讨论】：

这对于刚接触 Android Studio 文档的人来说非常重要，因为 Android Studio 无法识别 @link 命令...