Android Studio中Javadoc @link 引用

Question

我正在尝试使用Android Studio生成一些Javadocs。我正在参考同一类中的方法，使用{@link #method()}链接，但是Javadoc仍然显示未找到引用错误。很可能是我遗漏了一些非常愚蠢的东西，但我无法弄清楚是什么。是否有其他人遇到过相同的问题？

- Genís

---

已提交了一个错误报告 - 看起来很相似 - 尽管它与自动完成有关，但您可能会在此处获得一些额外的信息： https://code.google.com/p/android/issues/detail?id=67855 - AgentKnopf

Answer 1

在 Android Studio 中的 javadoc 注释中，尝试键入{@，然后按ctrl+space查看弹出什么内容...

选择link后，按space。

现在再次按ctrl+space，以获得所有可能类别的列表。

如果只是想引用当前类别中的方法/数据，那么请键入#，然后按ctrl+space，以获得可能需要的列表。

不要忘记确保括号已关闭！

- SMBiggs

---

如何引用XML文件？类似于{@link res/custom_strings.xml}。 - rexxar

@Rexxar：不知道，但那是一个非常好的问题！请继续将其作为一个单独的问题，并在此处发布链接供其他人使用。 - SMBiggs

感谢您的理解和鼓励之言！这是链接：https://dev59.com/QJ3ha4cB1Zd3GeqPadZL - rexxar

你知道怎么在注释中链接build.gradle文件吗？ - Rahul Khurana

@RahulKhurana 这是一个非常好的问题！你应该自己提出问题。这样其他人就可以轻松找到它了。 - SMBiggs

Answer 2

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

{@link package.class#member label}

这里有关于JavaDoc标签的更多信息。

- Richard Goggin

---

因为它没有解决这些显示的问题的原因。长话短说，当您在Android Studio中扩展视图并覆盖方法并选择添加覆盖方法的javadoc时，其中的链接不包括链接中的包名称。而且，Android Studio会对此感到困惑，您必须使用一些搜索和替换手动修复它们。例如，android.view.View＃View（Context，AttributeSet，int，int）被导入到您的视图扩展类中，如see＃View（Context，AttributeSet，int，int），您需要手动修复。 - Lassi Kinnunen

您是否知道如何在注释中链接 build.gradle 文件？ - Rahul Khurana

Answer 3

我不知道是否还有人在苦苦挣扎，但如果你正在努力而且 {@link 无法工作，请确保你的注释块看起来像这样。

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

确保注释块以两个*开头而不是一个，显然在我的安卓工作室中可以使用此方法。

- adam

---

对于那些在Android Studio文档编写方面新手来说，这非常重要，因为Android Studio无法识别@link命令... - Nikhil Sharma