Eclipseでドキュメントをインテリジェントに修正するには？

Question

私のC＃の日には、 "GhostDoc"というVisual Studioエクステンションの使用が大好きでした。今、私はJava開発者として使用されています。私はEclipseを使用しています。私はドキュメンテーションを推論することなく生きることができますが、私がしたいのは、ドキュメントをインテリジェントに "修正"することです。たとえば、のは、私は次のメソッドを持っていると仮定してみましょう：

/** 
* Gets a collection of {@link Foo} objects 
* @param bar The bar level 
* @param baz The bazziness 
*/ 
public Collection<Foo> getFoos(int bar, int baz) 
{ 
    // Do something cool 
} 

後で開発に私は私の方法の消費者はqux値を渡すことができるように有用であろうことを実現します。それだけでなく、それを最初のパラメータとして持つことが最も理にかなっています。また、私は非常に便利なFooBarExceptionをスローするメソッドを持つつもりです。だから私の方法は次のようになります：

/** 
* Gets a collection of {@link Foo} objects 
* @param bar The bar level 
* @param baz The bazziness 
*/ 
public Collection<Foo> getFoos(String qux, int bar, int baz) throws FooBarException 
{ 
    // Do something cool 
} 

私はJavaDocに変更を反映させたいと思います。 GhostDocではドキュメントのショートカットキーを押すことができ、古いものを乱さずに新しいものを追加できます。 Eclipseでは、JavaDocのまったく新しいセットをレンダリングするので、私はたくさんのコピーを行う必要があります。新しい@param、@exception、および欠落した@returnsパラメータを現在のJavaDocを失うことなくJavaDocに自動的に挿入するにはどうすればよいですか？

Answer 1

わからない以下の場合は、あなたがメンター何ですが、Eclipseは、独自のJavaDocのバリデータを持っているので、あなたは

ウィンドウの下に警告/エラーをコンパイル設定することができます - >設定 - > Javaの - >コンパイラ - >のJavaDoc。

javadocタグを必要に応じてアクティブにし、警告レベルを「警告」に設定すると、javadocがメソッドのシグネチャと異なると、コンパイラは変更を認識して警告を表示します。これを修正するために、クイックフィックス（STRG + 1）が用意されており、欠落しているタグをすべて追加することができます。この操作は、あなたの古いコメントを乱すことなく、適切な場所にも欠けているタグを追加します。

Answer 2

Eclipseサポート "code" -completion for JavaDocもサポートされています。穴のステートメントを入力する必要はありません。 "@p"と入力するだけでCTRL + Spaceが残りの部分を表示します。それとも、コードメーターの名前を書くだけで、コード補完によって残りの部分が追加されます。

これは直接的なショートカットではありませんが、javadocの処理速度は、最初からすべてを書き込むよりも速くなります。

@t（@throw）@r（@return）などと同じです。あなたのコメントへ

編集：

あなたは自動的にあなたのクラスをチェックするため、Checkstyleのを設定することができます。 Checkstyleは、メソッドに文書化されていないパラメータまたはその他の欠落しているパラメータがある場合にレポートします。 Checkstyleは、最初の文が '。'で終わるかどうかをチェックすることもできます。か否か。あなたは手でこのようなルールをたくさんすることができます。

CheckstyleはJavaコードエディタに問題マーカーを追加し、問題を表示します。したがって、javadocの問題でコード行を簡単に見つけることができます。

Answer 3

標準的なコメント欄（GhostDocと同じ場所）より上に/ **を入力すると、コメント用のテンプレートが自動的に完成します。

名前変更機能（Shift + Alt + R）を使用して変数の名前を変更した場合、Eclipseはコードがコンパイルされていると仮定して、すべての適切な場所の名前も変更します。

これには、コメントリンクあなたもこれらの参照を更新するEclipseの名前変更機能を使用してmyThingかMyThingClassのいずれかの名前を変更する

/** 
* 
* My funky method 
* 
* @param myThing 
*   myThing is of type {@link MyThingClass} 
*/ 
public void myMethod(MyThingClass myThing) {} 

を作りました。

同様に、「変更メソッドシグネチャ」機能を使用すると、基本的には。あまりにも

をあなたのコメントを更新しますあなたがすべてでリファクタリングしている場合、リファクタリングメニュー（Shiftキー+ Altキー+ T）を使用します。

Answer 4

Checkstyleはすでに述べました。私はそれを試しましたが、それは私のEclipse（E4ジュノ、それはいくつかの悪い減速を持つために知られている）を遅くするように見えた。

Google CodeProはより良い仕事をしていたので、今私は今これを使用しています。

もちろん、JavaDocの警告を有効にすることができます。

Answer 5

http://jautodoc.sourceforge.net/ 作品だけでなくルナと同様 市場の場所