如何使用@link
标记链接到方法?
我想改变:
/**
* Returns the Baz object owned by the Bar object owned by Foo owned by this.
* A convenience method, equivalent to getFoo().getBar().getBaz()
* @return baz
*/
public Baz fooBarBaz()
收件人:
/**
* Returns the Baz object owned by the Bar object owned by Foo owned by this.
* A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
* @return baz
*/
public Baz fooBarBaz()
但是我不知道如何正确格式化@link
标签。
3条答案
按热度按时间ctehm74n1#
您可以在 * Documentation Comment Specification for the Standard Doclet * 找到有关JavaDoc的许多信息,包括有关
{@link模块/包.class#成员标签}
你所寻找的,文档中相应的示例如下所示
例如,这里有一个注解,它引用了getInteger(int,int)方法:
Use the {@link #getComponentAt(int, int) getComponentAt} method.
如果引用的方法在当前类中,则可以省略
module/package.class
部分。关于JavaDoc的其他有用链接是:
dldeef672#
来自javadoc文档的@link部分的通用格式是:
示例
同一类中的方法:
*不同类中的方法, 在同一包中或导入:
**不同包中的方法 * 且未导入:
链接到方法的标签,使用纯文本而不是代码字体:
**方法调用链,**如您的问题。我们必须为指向该类之外的方法的链接指定标签,否则我们将得到
getFoo().Foo.getBar().Bar.getBaz()
。但是这些标签在重构过程中可能很脆弱--请参阅下面的“标签”。标签
**自动重构可能不会影响标签。**这包括重命名方法、类或包;并改变方法签名。
因此,如果您需要与默认文本不同的文本,请仅提供标签。
例如,您可以从人类语言链接到代码:
或者,您可以使用不同于默认值的文本从代码示例链接,如上面的“方法调用链”中所示。
类型擦除和#成员
如果方法签名包括参数化类型,请在javadoc @link中使用这些类型的擦除。举例来说:
goqiplq23#
你可以使用
@see
来实现:示例: