一つは、自動的に全体のEclipseプロジェクトのJavadocタグを作成することはできますか?
-
16-09-2019 - |
質問
私は1つの単一のコード要素(例えば、クラスメソッド)のためのタグを作成する「
しかし、自動的にプロジェクト全体ですべてのクラスのためにこれらのタグを作成する方法はありますか?あるいは単にパッケージまたはクラスレベルで?
解決
あなたは JAutodoc の?
を見てきました他のヒント
私が知らないことを。
それはとにかく何の役に立つのでしょうか?自動生成されたJavadocコメントは無用より悪いです。私はむしろ彼らが私のコードを乱雑に持っていないだろう、とJavadocがなくてもコメントが存在してできるだけ多くの情報を提供します。
自動は、他の人が今の方法は何をすべきではありません決して、あなたは1年後にクラスを見たとき、自分自身にも、それを知ることができませんので、javadocは、痛みで生成されました。
自分で方法をコメントしたりする方法をコメントしないでください。
私の会社は、Javadocを追加するために雇用者を強制するのCheckstyleを使用しています。いくつかの雇用者は彼らの方法をコメントし、ちょうどsenslessコメントを入力するためにそれを嫌います。それは無用以下のコメント自分ではないという方がよいでしょう。
のCheckstyleを使用すると、ウェルフォーマットでそれらを文書化するために、すべての文書化されていない方法を見つけることができます。
のようなinitメソッドを文書化するのに役立ちますどのような
"initがどんな前に呼び出されなければなら 他の方法とクラスを初期化 ActionDummy "
正確に行われているものを教えてくれた方が良いです。
のデフォルトの状態をInizializes アクション・プロバイダ。いくつかの状態変数をすることができ リスナーによってオーバーライドするとき....