2012-03-28 15 views
2

Eclipseでは、要素にカーソルを置くと、Javadocだけが表示され、要素の(拘束されていない)署名が表示されます。Eclipseでは、Javadocでジェネリック型の制約をどのように表示できますか?

class X <T extends Object> {}があるとします。 EclipseのJavadocジェネレータを使用すると、次のようになります。

/** 
* @param <T> 
*/ 

レンダリングされたJavadocはこのようになります。型制約情報がないことに注意してください。

 com.domain.X<T>  Parameters:   <T>

EclipseでのJavadocビューアからジェネリック型の制約を表示する方法はありますか?

+1

なぜ宣言自体に自明なものを記載したいのですか? –

+1

@edalorzo Eclipseでは、要素にカーソルを置くと、Javadocだけが表示され、要素の(拘束されていない)署名が表示されます。私はJavadocでそれを見たいと思います。 –

答えて

2

この問題を解決するためにEclipse bug/enhancementと入力しました。信じられないほど、Markus Kellerは実際に提出から3〜4時間以内にこれを実装/修正しました!

0

クラスの本体にはすでにT extends Objectと書かれていますが、javadocではその必要はありません。

(コードまたはのjavadocなどのコメント)物事を文書化、これらの2つの規則に従います。

  • は自分を繰り返さないでください。これに従わないと、コメントとコードを同期させるのがずっと難しくなります。
  • 明確な内容を文書化しないでください。あなたのコードの読者は、その言語を知っています。例えばキャストをしたことを説明する代わりに、WHYをキャストしました。
+0

これは、EclipseのJavadoc実装の刺激的な制限だと思われます。 Eclipseが表示されたJavadocにこの情報を追加しないからといって、手動でJavadocに文書化する必要はないはずです。 –

+0

質問を適切に書き直しましたので、お気軽に回答を削除してください。 –

関連する問題