[解決済み] seeと@inheritDocの違いについて詳しく説明します。

質問

に目を通しました。 JavaDocリファレンス との基本的な違いは理解していますが @see (各種リンク)と {@inheritDoc} (スーパークラスのエクスポート JavaDocコメント) が、実際にどのように実装されているのかを明確にする必要があります。

Eclipse IDEで、継承されたメソッド（インターフェースやtoString()のオーバーライドなど）の「要素のコメントを生成」を選択すると、以下のコメントが作成されます。

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

JavaDoc を作成する必要がある場合、そのままにしておくべきか、それとも次のように置き換えるべきか。 @see で {@inheritDoc} で回すか 善意 このようなJavaDocです。

/**
 * {@inheritDoc}
 */

その際、class#methodフラグはそのままで良いのでしょうか？

どのように解決するのですか？

まず、オリジナルのeclipseのテンプレートは、うるさいだけのガラクタなので、削除した方がいいです。意味のあるドキュメントを入れるか、何も入れないかのどちらかです。しかし、IDEのテンプレートを使って無駄な再掲をするのは、コードを乱雑にするだけです。

次に、javadocの作成が義務付けられているのであれば ある で始まるコメントとする。 /** . そうでなければ、javadocではありません。

最後に、もしオーバーライドするのであれば、その時は @inheritDoc (にしたい場合を想定しています）。 追加 に、@seh がコメントで指摘したように、オリジナルのドキュメントを複製するだけなら、何も必要ありません)。 @see を参照するためにのみ使用されるべきです。 その他 関連するメソッドです。