105

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

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

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

JavaDocを作成する必要がある場合は、そのままにしておくか、に置き換えるか@see、{@inheritDoc}または真正なJavaDocに変換します。

/**
 * {@inheritDoc}
 */

そして、それを行うときでも、class＃methodフラグを保持する必要がありますか？

4

1 に答える 1

156

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

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

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

于 2012-11-11T01:01:34.743 に答える