@ see 在 JavaDoc 中的用法？

@ see 对于 API 中相关方法/类的信息非常有用。它将产生一个到文档中引用的方法/代码的链接。当有相关代码可以帮助用户理解如何使用 API 时使用它。

是的，很模糊。

无论何时，只要读者了解了方法的文档，查看其他方法可能会有用，就应该使用它。如果您的 methodA 的文档说“工作方式类似于 methodB，但是...”，那么您肯定应该放置一个链接。 @see的一个替代方案是内联 {@link ...}标签:

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

如果 methodA 调用 methodB 是一个实现细节，并且没有实际的外部关系，那么这里就不需要链接了。

@see可以派上用场的一个很好的例子是实现或重写接口/抽象类方法。声明将包含详细说明该方法的 javadoc部分，并且重写/实现的方法可以使用 @see标记，引用基本的标记。

相关问题: 用@来写正确的 javadoc，看到了吗？

Java SE 文档: @see

我使用@see 来注释接口实现类的方法，其中方法的描述已经在接口的 javadoc 中提供。当我们这样做时，我注意到，即使在代码完成期间查找实现引用的方法时，Eclipse 也会调出接口的文档

@see标记与 @link标记略有不同,
在某些方面有限，在其他方面更灵活。
下面的例子来自 Eclipse:

^{不同的 JavaDoc 链接类型}

1. 显示成员名称以便更好地学习，并且是可重构的; 在通过重构进行重命名时，该名称将更新
2. 可重构且可自定义; 显示文本而不是成员名称
3. 显示名称，可重构
4. 可重构，可定制
5. 一个相当 平庸的组合是:

• 可重构、可定制并保留在 参见部分
• 在 Eclipse 悬停中显示良好
• 显示链接标记及其生成时的格式
• 当使用多个 @see项时，说明中的逗号会使输出混淆

6. 完全非法 ; 在生成器中导致意外内容和非法字符错误

请参阅以下结果:

^{JavaDoc 生成的结果具有不同的链接类型}

最好的问候。