java - 在 javadoc 的 @see 中使用指向网站的链接是不好的做法吗？

Question

根据我对@see 的了解，它用于允许用户单击到 javadoc 中引用的类、方法等的 javadoc，因此，如果用户有一个操作图像的方法，它可能有@看图片。

@see 是否可以链接到网站？在这种情况下，我使用的 API 没有 Java 文档，但它在创建者网站上确实有 API 文档，因此用户能够查看我引用的类或方法的唯一方法是无论如何访问该网站。或者在@see 中使用网站链接是否违背了其预期目的？

Answer 1

我相信这很好。 javadoc 文档中甚至有一个示例 here

@see <a href="spec.html#section">Java Spec</a>

当然，您冒着以过时链接结束的风险，尤其是在将您的文档捆绑在下载中时。您可能需要考虑指向您控制的重定向页面，以便您可以在发布文档后更新目标页面。