2011-01-04 19 views
26

/* (non-javadoc)には、コメントブロックが意図的にJavadocのコメントではないことをソースコードの読者に指摘する以外に意味がありますか?最近、私はこのようなコードをたくさん見てきました:"/ *(非javadoc)"はよく理解されていますか?

/* 
* (non-javadoc) 
* 
* This method converts widgets to gizmos 
*/ 
public Foo bar() { 
    ... 

これはいくつかの種類の確立された慣習ですか?もしそうなら、(明白な文字通りの意味を超えて)それは何を意味し、いつ使用されますか?

答えて

18

info I could findによると、これは、以前のバージョンのJavaDocツール(またはEclipseのJavaDocコメントの古いバージョン)のバグを修正して、メソッドをオーバーライドするメソッドの正しいドキュメントを表示しないことでした。親クラス。

Konstantinが指摘したように、Eclipseのオーバーライドテンプレートにはこのテキストが含まれています。

+1

FYI:http://dev.eclipse.org/newslists/news.eclipse.platform/msg34412.htmlは現在死んでいます。 –

+3

@ MaxNanasy明らかにEclipseはフォーラムシステムを少し前に変更し、個々の投稿をリダイレクトしなかったようです。新しい場所はhttps://www.eclipse.org/forums/index.php/m/278495/です – Powerlord

15

コメントの他に確立された意味はありません。書式設定は、一般的なEclipseコード書式設定テンプレートの結果であり、その共通性が説明されています。

関連する問題