Android Studio 中的 JavaDoc @link 包

Question

我需要 link 到 JavaDoc 中的包。

示例：

@param example description (see {@link com.example.packagename this})

使用上面的代码，我得到了这条消息：

warning - Tag @link: reference not found: com.example.packagename

链接到同一包中的 class 工作正常，但我需要 link 直接链接到包。

Answer 1

@link不可能。

在您的 com.example.packagename

中创建 package.html 文件或单个 package-info.java

/**
 * This is packagename
 */
package com.example.packagename;

然后你可以link使用@see.

这个包

/**
 * @param example description
 * @see com.example.packagename
 */
void doWork(String example) {

}

现在您 android 工作室将显示文档如下：

通过点击 com.example.packagename，将显示 package-info.java 中的 javadoc。

注意：您可以使用 <a> 标签而不是直接 linking 包名：

 * @see <a href="{@docRoot}/com/example/packagename/package-summary.html">Packagename</a>

JavaDoc @link package in Android Studio