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

Question

假设您的班级有两种方法：

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