根据我对@see的理解,它用于允许用户点击javadoc中引用的类、方法等的javadoc,所以如果用户有一个操作图像的方法,它可能有@参见图片。
@see 可以链接到网站吗?在本例中,我使用的 API 没有 java 文档,但在创建者网站上确实有 API 文档,因此用户能够查看我引用的类或方法的唯一方法是无论如何访问该网站。或者在 @see 中使用网站链接是否违背其预期目的?
最佳答案
我相信这很好。 javadoc 文档中甚至还有一个示例 here
@see <a href="spec.html#section">Java Spec</a>
当然,您面临着获得过时链接的风险,特别是如果将您的文档捆绑在下载中。您可能需要考虑指向您控制的重定向页面,以便您可以在发布文档后更新目标页面。
关于java - 在 javadoc 的 @see 中使用网站链接是一种不好的做法吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27398324/