如何在Javadoc中引用同一类的另一种方法?

詹姆斯·赖采夫(James Raitsev):

假设您的课程有2种方法:

contains() and
containsSame()

它们之间的区别很细微,您想在Javadoc中提及它

在Javadoc中,如何通过名称引用同一类中的方法?

Pablo Ebermann:

使用@link内联标签,并使用前导引用该方法#

/**
 * ...
 * This method is similar to {@link #contains()}, with the following differences:
 * ...
 */
public boolean containsSame();


/**
 * This method does ...
 */
public boolean contains();

此示例仅在实际上存在一个contains()没有参数方法(实际上似乎没有那么有用)的情况下才有效。如果只有contains带有参数方法,则可以在括号中输入参数类型:

/**
 * ...
 * This method is similar to {@link #contains(Element)}, with the following differences:
 * ...
 */
public boolean containsSame(Element e);

/**
 * This method does ...
 */
public boolean contains(Element e);

或者,您可以完全省略括号:

/**
 * ...
 * This method is similar to {@link #contains}, with the following differences:
 * ...
 */
public boolean containsSame(Element e);

/**
 * This method does ...
 */
public boolean contains(Element e);

如果您有几种已命名的方法contains(具有不同的参数列表),则此版本无法决定要使用哪种方法(链接将跳至其中的任何一种,希望它们在一起并做相似的事情)。

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章

在Python中的同一类中从一种方法调用列表到另一种方法

在Selenium中将Webdriver实例从一种方法传递到另一种方法(同一类)

另一种方法的Javadoc参考参数

当两种方法都在同一个类中时,如何使在一种方法中定义的列表在另一种方法中可用?

Android将参数从一种方法获取到另一类的另一种方法

如何在同一活动中将变量从一种方法传递到另一种方法

稍后如何在另一种方法中利用用户输入

如何在另一种方法中传递参数?

如何在java中将Int从一种方法返回到另一种方法

如何在另一种方法中使用一种方法的“返回”值

如何在scrapy中将信息从一种方法传递到另一种方法

在Laravel 5.2中如何在一种方法中设置会话并在另一种方法中获取会话数据

如何将一种方法中的变量用于另一种方法?

Django Rest Framework 如何从一种方法调用另一种方法中的变量?

如何从另一种方法正确调用一种方法

在 Python 中从另一种方法调用一种方法

如何从另一种方法使用数组?

参数如何在c#中工作(一种方法据称隐藏了另一种方法)

传递函数以引用Java中的另一种方法

工厂有两种方法,一种是带有$ promise的$ http方法-如何从第一种方法的成功函数中引用另一种方法?

类中的PHP方法与另一种方法?

ES6类中实现数据隐私的另一种方法

如何在另一种方法的方法中使用来自 HashMap 的数据?

如何以另一种方法从列表中获得一个结果?

如何在另一种方法中使用MouseMotion int

如何在Activity的另一种方法中使用LiveData值?

如何在vue组件中使用另一种方法的变量?

DART / FLUTTER-如何在另一种方法中使用MysqlConnection的变量?

如何在swift3中以另一种方法访问UITableView单元格