@链接到包中的另一个包-info.java
有没有办法将package-info.java链接到这个包之外的另一个包(在同一个项目中) 如果我尝试在java 7中这样做,我总是会得到:@链接到包中的另一个包-info.java,java,javadoc,Java,Javadoc,有没有办法将package-info.java链接到这个包之外的另一个包(在同一个项目中) 如果我尝试在java 7中这样做,我总是会得到: warning - Tag @link: reference not found: 您必须导入使用过的包,以便javadoc知道您引用的名称空间 package-info.java应该查看以下链接: import package.subpackage.ClassnameYouWantToLink; /** * {@link ClassnameYouWan
warning - Tag @link: reference not found:
您必须导入使用过的包,以便javadoc知道您引用的名称空间 package-info.java应该查看以下链接:
import package.subpackage.ClassnameYouWantToLink;
/**
* {@link ClassnameYouWantToLink}
*/
如果您不想导入包,则需要在类名前面输入完整的经验证的包名:
/**
* {@link package.subpackage.ClassnameYouWantToLink}
*/
带有
@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}
标记都无法处理到包的链接。这更多是一种解决方法,但至少如果你链接到包com.foo.Bar
Eclipse中的某个文件,你就可以通过在内联预览等中将鼠标悬停/点击foo
来从Bar
导航到package info.java
描述中。
和
我的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;
/**
*但是,请注意,{@link gov.va.med.srcalc.domain}中的类
*通过JPA注释定义绝大多数数据映射
*/
包gov.va.med.srcalc.db;
我们使用Gradle作为构建工具,但是我发现Gradle没有生成链接,并生成一个
参考未找到:gov.va.med.srcalc.domain
警告。也许这是Gradle中的一个bug。一半的答案是{@link some.package.name}
确实链接到了包
另一半的答案,正如我刚刚幸运地发现的,是
javadoc
必须在命令行上用包名调用。好吧,这是一个猜测,因为我实际上正在使用ant的
任务,但一旦我添加
,则引用未找到
警告消失,并且生成的javadoc中的链接可用。我认为op想要链接到包,包中没有对象。包是文件夹,不能包含Java文档本身(并且只能链接到文件)。因此,按照惯例,您可以在包中添加一个包信息
类,并链接到此类。为此,您不能在package-info.java中使用导入。导入在包之后,javadoc在package元素上,因此导入在javadoc之后,而javadoc编译器没有看到它。您知道如何做到这一点了吗?(并且:您确实希望引用另一个包,而不是包中的某个东西,对吗?)当您实际生成文档时,这可能会起作用,但在Eclipse中不适用于动态弹出文档。Eclipse确实支持{@link com.mypackage}形式的链接。