java - Eclipse プロジェクト全体の javadoc タグを自動的に作成できますか?

Question

「<alt><shift>J」を使用して、単一のコード要素 (クラス メソッドなど) のタグを作成できることはわかっています。

しかし、プロジェクト全体のすべてのクラスに対してこれらのタグを自動的に作成する方法はありますか? それとも、パッケージまたはクラス レベルだけですか?

Answer 1

自動生成されたJavaDocは苦痛です。なぜなら、1年後にクラスを見ると、他の人はメソッドが何をすべきかを知ることができず、自分自身もそれを知らないからです。

自分でメソッドにコメントするか、メソッドにコメントしないでください。

私の会社はcheckstyleを使用して、雇用主にjavadocを追加するように強制しています。一部の雇用主は、自分たちの方法にコメントすることを嫌い、無意味なコメントを入力するだけです。役に立たないよりもコメントがない方がいいでしょう。

checkstyleを使用すると、文書化されていないすべてのメソッドを検索して、適切な形式で文書化できます。

次のようなinitメソッドを文書化するのに役立つもの

「initは他のメソッドの前に呼び出され、クラスActionDummyを初期化する必要があります」

正確に何が行われているのかを伝える方が良いです

アクションプロバイダーのデフォルト状態を初期化します。一部の状態変数は、リスナーが...の場合にオーバーライドできます。