別のメソッドのドキュメントを表示するためのJavadocタグ

Question

別のメソッドのドキュメントを表示するためのjavadocタグはありますか？これらは、呼び出しを他のクラスのメソッドに単に中継するメソッドです。私は@see以上を探しています。ありがとう。

Answer 1

{@link MyClass#myMethod(String, etc.)}を使用すると、ツールチップにクリック可能と表示され、クリックするとJavaDocがmyMethodと表示されます。 }の前に説明を追加することもできます。

Answer 2

任意の方法のドキュメントを含めるメカニズムはありません。

ただし、メソッドのコメントで、および/または@param、@returnと@throwsタグにusing the tag {@inheritDoc}、最寄りのスーパークラスまたはインタフェースで宣言されたのと同じ方法でドキュメントを継承することができます。例えば

：

public class Foo { 
    /** Implements the equals method for Foo objects. 
    * <p>Follows the contract specified by {@link java.lang.Object#equals(Object)}:</p> 
    * 
    * {@inheritDoc} 
    * 
    * @param obj {@inheritDoc} 
    * @return {@inheritDoc} 
    */ 
    public boolean equals(Object obj) { 
    ... 
    } 
    ... 
}