Javadoc：链接到package-info

Question

我在我的javadoc中使用package-info.java文件。我试图从包含在该包中的类链接到相同包的package-info。我尝试了几个选项，受这个Oracle文档的启发。

例如，包是：

com.zombo.apps.api.stream

我在com.orcsoftware.apps.api.stream.someClass中，正在编写

@see com.zombo.apps.api.stream.package-info

但该链接在javadoc中未被渲染。我如何链接到package-info？

- seb

Answer 1

如果您删除.package-info，它应该可以正常工作：

@see com.zombo.apps.api.stream

- Lolo

---

谢谢。我之前尝试过，但没有成功。你的评论让我再次尝试。我调整了javadoc编译设置。我还必须设置包标志。这使它工作了。如果没有你的评论，我几乎要放弃了！谢谢。 - seb

Answer 2

如果想引用package-info而不使用@see标签，可以使用{@link com.zombo.apps.api.stream}。

- r-uu

Answer 3

在模块应用程序中（当源路径中有一个module-info.java文件时），包链接应该以模块名称引用开头。例如： @see module/package.class#member 请参阅章节“References”中的https://docs.oracle.com/en/java/javase/20/docs/specs/javadoc/doc-comment-spec.html。

- Alexey Gavrilov