17

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 のまったく新しいセットがレンダリングされるため、コピー パスタを大量に実行する必要があります。現在持っている JavaDoc を失うことなく、新しい@param、@exception、および不足しているパラメータを JavaDocに自動的に挿入するにはどうすればよいですか?@returns

4

5 に答える 5

18

以下があなたのメンションであるかどうかはわかりませんが、eclipseには独自のJavaDocバリデーターがあるため、コンパイルの警告/エラーを以下で構成できます。

ウィンドウ->設定->Java->コンパイラ->JavaDoc。

不足しているjavadocタグを自分のニーズに合わせてアクティブ化し、警告レベルを「警告」に設定すると、javadocがメソッドのシグネチャと異なるとすぐに、コンパイラは変更を認識して警告を出します。それを修正するために、クイックフィックス（STRG + 1）を提供し、不足しているすべてのタグを追加することを選択できます。この操作により、古いコメントをいじることなく、不足しているタグが適切な場所に追加されます。

ここに画像の説明を入力してください

于 2012-10-17T16:19:08.507 に答える
2

http://jautodoc.sourceforge.net/ は Luna でも問題なく動作します。マーケット プレイスで確認してください。ここに画像の説明を入力

于 2015-07-02T16:23:35.747 に答える
2

Eclipse は、JavaDoc の「コード」補完もサポートしています。ホール ステートメントを入力する必要はありません。「@p」と入力するだけで、CTRL + スペースで残りが表示されます。またはさらに良いことに、パラメーターの名前を書くだけで、コード補完が残りを追加します。

これは直接的なショートカットではありませんが、最初からすべてを作成するよりも高速に Javadoc を拡張できます。

@t (@throw) @r (@return) なども同様です。

コメントを編集します。

クラスを自動的にチェックするように、Checkstyle を構成できます。メソッドに文書化されていないパラメーターまたはその他の欠落しているパラメーターがある場合、Checkstyle は報告します。Checkstyle は、最初の文が「.」で終わっているかどうかもチェックできます。か否か。このようなルールを手動で多数作成できます。

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

于 2012-10-17T15:56:06.137 に答える
1

チェックスタイルはすでに言及されました。私はそれを試しましたが、Eclipse の速度が大幅に低下したように見えました (ただし、E4 ジュノは、速度が低下することで知られています)。

Google CodeProの方が優れていたので、現在はこれを使用しています。

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

于 2013-01-01T18:01:12.610 に答える
1

一般的なコメントの場所 (GhostDoc と同じ場所) の上に /** と入力すると、コメントのテンプレートが自動完成します。

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

これには、作成したコメント リンクが含まれます

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

Eclipse の名前変更機能を使用して myThing または MyThingClass の名前を変更すると、これらの参照も更新されます。

同様に、「メソッド シグネチャの変更」機能を使用すると、コメントも更新されます。

基本的に、リファクタリングを行う場合は、リファクタリング メニュー (Shift+Alt+T) を使用します。

于 2012-10-17T16:08:38.793 に答える