2009-12-07 19 views
5

私はコードベースで作業しています...乱雑です。この混乱の一面は、署名がもはや関連するJavadocと一致しない大量のメソッドがあることです。例えば:自動的にJavadocを更新するためのツールはありますか?

/** 
* 
* @ param foo 
*/ 
public void doFoo(int bar) {... 

(それは常に価値がないほとんどだと)私は、生成されたJavadocのないファンだんが、私は本当にそのような例を見つけ、私たちのコードを行くだろうツールを使用することができ、そして:

  1. は「バー」のparam(ちょうど空白の1、ノー自動生成されたドキュメントまたは何か)

ようなツールが存在するかのJavadocを追加「foo」というのparamのJavadocを削除しますか?そうでない場合、#1だけのツールが存在しますか?それでも多くの場合、ビルドでのゴミ警告の量が大幅に削減されます。ありがとう。

+0

P.S.私はすでにそういう質問を探していましたが(それがあったと思っていたので)、何百もの質問をしてきたが、まだ何も出てこなかったので、新しい質問:-) – machineghost

答えて

3

NetBeansにはそのためのツールがあります。それはまさにあなたが求めるものです。

あなたは、どちらかのファイルの一番上、 または右クリックしてから、その後、ToolsメニューにAnalyze Javadocsをクリックすることができ、その後ToolsAnalyze Javadocsクリックしてください。

これで、Javadocで見つかったすべての問題のリストが表示され、修正するオプションが表示されます。メソッド内で単一の問題を修正したり、メソッド、ファイル、パッケージ、またはプロジェクト全体のjavadocを修正することができます。

+1

デフォルトでは(** Netbeans 8.0.2 **以上で)このツール**はプライベートメソッドでJavaDocでエラーを見つけられません**。**の範囲を変更するためにJavadocを分析する**ツール - >オプション - >エディタ - >ヒント - > JavaDoc - > Javadocのエラー - >スコープを開き、スコープをprivateに変更します。 –

3

Eclipseを使用している場合、1つの解決方法は、Window -> Preferences -> Java -> Compiler -> Javadoc に移動し、「不正な形式のJavadocコメント」変数を警告またはエラーに設定することです。

次に、問題ビューWindow -> Show View -> Problemsに行き、各エラーで右クリックして「クイックフィックス」を選択することができます。

+0

これは(私はNetBeansソリューションを答えとしてマークしましたが、より強力なので、私は個人的にEclipseユーザーです)。しかし、警告のどれも問題に表示されません:-(私がそれらの1つを見ると、その下に黄色の波状の線がありますが、Eclipseにそのファイルを検証するよう指示しても、問題のウィンドウには何も表示されません。 – machineghost

2

DocCheck以外で試したことはありませんが、this somewhat-dated page on Sun's siteにはサードパーティのドックレットがいくつか記載されています。その中には、Javadocをソースに挿入するものがあります。そのうち、Doc-o-MaticJRefactory Pretty PrinterACTOS Auto Commentator for Javaをご覧ください。繰り返しますが、私はこれらのどれも試していませんが、始める場所です。

関連する問題