web-dev-qa-db-ja.com

@seeと@inheritDocの違いの詳細

JavaDocリファレンス を見ましたが、@see（さまざまなリンク）および{@inheritDoc}（スーパークラスのJavaDocコメントのエクスポート）、実際に実装する方法を明確にする必要があります。

EclipseでIDE継承されたメソッド（インターフェイスまたはtoString（）オーバーライドなど）に対して[要素コメントの生成]を選択すると、次のコメントが作成されます）

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */

JavaDocを作成する必要がある場合は、そのままにしておき、@see with {@inheritDoc}、またはbona fideJavaDocを有効にする：

/**
 * {@inheritDoc}
 */

そして、私がそれをするとき、私はまだclass＃methodフラグを保持すべきですか？

javajavadoccommenting
77
theUg

まず、元のEclipseテンプレートはノイズの多いジャンクなので削除する必要があります。意味のあるドキュメントを入力するか、何も入力しないでください。しかし、IDEテンプレートを使用して明白なものを無駄に言い換えると、コードが乱雑になります。

次に、javadocを作成する必要がある場合は、haveでコメントを/**で開始します。それ以外の場合は、javadocではありません。

最後に、オーバーライドする場合は、@inheritDocを使用する必要があります（元のドキュメントを複製する場合は、コメントで@sehが指摘したように、元のドキュメントにadd 、その後は何も必要ありません）。 @seeは、実際にはother関連メソッドを参照するためにのみ使用する必要があります。

127
jtahlborn