JavaDoc中@see的用法?

什么时候使用@see与JavaDoc中处理时?它的用途是什么?

例如,如果MethodA呼叫MethodB然后做我必须把@seeMethodB的javadoc和引用MethodA,因为这就是所谓呢,还是我已经把一个引用MethodBMethodA,因为它调用它。我已经阅读了@seeOracle网站上的内容,在我看来似乎非常模糊,它表示“请参见”,但实际上并不意味着!

回答:

是的,这很模糊。

每当对方法文档的读者来说,都应该使用它,同时查看其他方法可能会很有用。如果您的methodA文档说“像methodB一样工作,但是…”,那么您当然应该放置一个链接。@see内联{@link

...}标签的替代方法是:

/**

* ...

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

*/

当methodA调用methodB的事实是一个实现细节,并且与外界没有真正的联系时,您无需在此处链接。

以上是 JavaDoc中@see的用法? 的全部内容, 来源链接: utcz.com/qa/433940.html

回到顶部