在处理 JavaDocs 时，我什么时候使用 @see？它的用途是什么？
例如，如果 MethodA 调用 MethodB 那么我是否必须将 @see 放入 MethodB 的 javadoc并引用 MethodA 因为这是调用它的原因，还是我必须从 MethodA 引用 MethodB 因为它正在调用它。我在 Oracle 网站上阅读了有关 @see 的内容，在我看来，它非常含糊，它说它的意思是“另见”，但并不是真正的意思!
最佳答案
是的，很模糊。
您应该在阅读您方法文档的读者时使用它，同时查看其他方法可能很有用。如果您的方法A 的文档说“像方法B 一样工作，但是...”，那么您肯定应该放置一个链接。
@see 的替代方法是内联 {@link ...} 标签:
/**
* ...
* Works like {@link #methodB}, but ...
*/
当methodA调用methodB是一个实现细节并且与外部没有真正的关系时，您不需要这里的链接。
关于java - JavaDoc 中@see 的用法？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/5011291/