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、このバージョンでは使用するメソッドを決定できません（リンクはそれらのいずれかにジャンプします。うまくいけば、それらはすべて一緒になって同様のことを行います）。