根据我对@see的了解,它用于允许用户单击javadoc中引用的类,方法等的javadoc,因此,如果用户具有操作图像的方法,则它可能具有@see Image 。

@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/

10-10 16:43