@link到package-info.java中的另一个包

Question

有没有办法从package-info.java链接到这个包之外的另一个包(在同一个Project中)？

如果我尝试在java 7中执行此操作,我总是得到:

warning - Tag @link: reference not found:

Answer 1

双方@link并@see 支持链接到包.

我的一个package-info.java文件中有以下代码,javadoc工具生成链接:

/**
 * <p>Note, however, that the classes in {@link gov.va.med.srcalc.domain}
 * define the vast majority of the data mapping via JPA annotations.</p>
 */
package gov.va.med.srcalc.db;

我们使用Gradle作为构建工具,但我发现Gradle不会生成链接并产生reference not found: gov.va.med.srcalc.domain警告.也许这是Gradle中的一个错误.

Answer 2

带有@docroot标准Java doclet工作的普通链接:

/**
 * See the 
 * <a href="{@docRoot}/com/mycorp/package-summary.html#package_description">
 *    package overview
 * </a> for more information.
 */

无论您是在package-info.java还是在类中都需要它,{@link}标签都无法处理包的链接.

Answer 3

您必须导入使用的包，以便 javadoc 知道您所引用的名称空间。

package-info.java 应该查看链接：

import package.subpackage.ClassnameYouWantToLink;
/**
* {@link ClassnameYouWantToLink}
*/

如果您不想导入包，则需要在类名前面添加完整的限定包名：

/**
* {@link package.subpackage.ClassnameYouWantToLink}
*/