在JavaDoc中使用@see?
何时使用@see
处理JavaDocs? 它的用法是什么?
例如,如果MethodA
调用MethodB
那么我必须将@see
放在MethodB
的javadoc中,并引用MethodA
因为这就是调用它的方法,或者我必须从MethodA
引用MethodB
,因为它调用它。 我已经阅读了Oracle网站上关于@see
,在我看来,这是非常含糊的,它表示这意味着“也看到”,但不是真正的意思!
是的,这是相当模糊的。
你应该使用它,只要为你的方法的文档的读者,也可以看看其他方法是有用的。 如果您的methodA的文档说“像methodB但是…”,那么你一定要把链接。 @see
的替代scheme是内嵌{@link ...}
标记:
/** * ... * Works like {@link #methodB}, but ... */
当methodA调用methodB这个事实是一个实现的细节,并且从外面没有真正的关系,在这里你不需要链接。
@see对于API中相关方法/类的信息很有用。 它将生成一个链接到文档中引用的方法/代码。 当有相关的代码可以帮助用户理解如何使用API时使用它。
@see
有用的一个好例子就是实现或覆盖一个接口/抽象类的方法。 该声明将有javadoc
部分详细说明该方法和重写/实施的方法可以使用@see
标记,指的是基地之一。
相关问题: 用@see写适当的javadoc?
Java SE文档: @see
我使用@see注释接口实现类的方法,其中方法的描述已经在接口的javadoc中提供。 当我们这样做的时候,我注意到,即使在代码完成期间我正在查找实现引用的方法时,Eclipse也会提取接口的文档