处理JavaDocs时应何时使用@see
?它的用途是什么?
例如,如果MethodA
调用MethodB
,那么我是否必须将@see
放入MethodB
的javadoc中并引用MethodA
,因为这就是所谓的名称,还是我必须从MethodB
引用MethodA
,因为它正在调用它。我已经在Oracle网站上阅读了有关@see
的内容,在我看来似乎非常模糊,它表示“也请参见”,但实际上并不意味着!
最佳答案
是的,这很模糊。
每当对方法文档的读者来说,都应该使用它,同时查看其他方法可能会很有用。如果您的methodA文档说“像methodB一样工作,但是...”,那么您当然应该放置一个链接。@see
的替代方法是内联{@link ...}
标签:
/**
* ...
* Works like {@link #methodB}, but ...
*/
当methodA调用methodB的事实是一个实现细节,并且与外界没有真正的联系时,您无需在此处链接。
关于java - JavaDoc中@see的用法?,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/5011291/