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という名前のメソッドがいくつかある場合（異なるパラメーターリストを使用）、このバージョンではどちらを使用するかを決定できません（リンクがそれらのいずれかにジャンプします。