在JavaDoc中使用@see？

methods java javadoc

2022-08-31 08:22:07

在处理 JavaDocs 时，我什么时候应该使用？它的用途是什么？@see

例如，如果调用，那么我是否必须输入的 javadoc 和引用，因为这是调用它的原因，还是我必须将引用放到 from，因为它正在调用它。我已经在Oracle网站上阅读了有关内容的内容，在我看来，它似乎非常模糊，它说它意味着“另见”，但并不是真正意味着什么！MethodAMethodB@seeMethodBMethodAMethodBMethodA@see

答案 1

是的，它非常模糊。

每当对于您的方法文档的读者来说，查看其他方法可能有用时，您都应该使用它。如果你的方法A的文档说“像方法B一样工作，但是......”，那么你肯定应该放一个链接。内联标记的替代方法是：@see{@link ...}

/**
 * ...
 * Works like {@link #methodB}, but ...
 */

当 methodA 调用 methodB 的事实是一个实现细节，并且从外部没有真正的关系时，这里就不需要链接。

答案 2

标签与标签略有不同，在某些方面受到限制，
在其他方面更灵活。
以下示例来自 Eclipse：@see@link

^{不同的 JavaDoc 链接类型}

显示成员名称以便更好地学习，并且是可重构的;通过重构重命名时，名称将更新
可重构和可定制;显示的文本而不是成员名称
显示名称，可重构
可重构、可定制
一个相当平庸的组合，是：

可重构、可自定义，并保留在“另请参阅”部分中
在 Eclipse 悬停时显示良好
生成链接标记及其格式时显示链接标记及其格式