java - 如何在 Javadoc 中引用同一类的另一个方法？

Question

假设您的班级有 2 个方法：

contains() and
containsSame()

它们之间的区别很微妙，您想将其作为 Javadoc 的一部分提及

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

Answer 1

使用@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（具有不同的参数列表），则此版本无法决定使用哪一个（链接将跳转到其中的任何一个，希望它们都在一起并做类似的事情）。