Android Studio中的JavaDoc @link包

Question

我需要链接到JavaDoc中的软件包。

示例：

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

使用上面的代码，我收到以下消息：

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

链接到同一包中的类可以正常工作，但我需要直接链接到该包。

Answer 1

@link无法实现。

在您的package.html中创建package-info.java文件或单个com.example.packagename

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

然后，您可以使用@see链接到此软件包。

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

}

现在，您的android studio将显示以下文档：

通过单击com.example.packagename，将显示package-info.java内的Javadoc。

注意： 您可以使用<a>标签来代替直接链接包名称：

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