web-dev-qa-db-ja.com

EclipseですべてのJavadocコメントを自動生成する方法はありますか?

Shift + alt + jを押して現在のコードブロックに適切なコメントテンプレートを挿入できることを知っていますが、Eclipseを夢中にさせて、このようなプロジェクト全体を実行する方法はありますか?

42
Finbarr

wholeプロジェクトの場合、そうではないかもしれませんが、少なくとも次のことができます。

  • パッケージエクスプローラービューに移動します
  • コメントを生成するクラスを展開します(各メソッドを開きます)
  • そのパッケージエクスプローラーツリーからクラスで開かれているすべての要素を選択します
  • alt+shift+J およびvoilà:クラスおよびすべてのメソッドで生成されたコメント

すべてのプロジェクトにとって実用的でない唯一の理由は次のとおりです。

  • コメントを生成するすべてのクラスを開く必要があります
  • メソッドの最初のセットがコメント化された後、新しいメソッドを作成した場合は、プロセスを繰り返す必要があります。

そうは言っても、2010年3月30日の記事「The不完全なJavadocsの問題」には別のアプローチが記載されています。 拡張Javadocビュー.

拡張されたJavadocビューは、基本的に、クラス、メソッド、フィールド、パラメーターなどの単一のコード要素のさまざまな情報ソースのアグリゲーターです。既存のEclipse Javadocの代替として設計されています。

alt text

興味深い部分は、ビューの他のタブに付属しています:サブクラス化ディレクティブとサブクラス化パターン
これらのタブには、開発者が選択したコード要素を通常どのように拡張したかに関する情報が含まれています。

  • サブクラス化タブ:

サブクラス化ディレクティブは、「Wizardのメソッドは常にそのメソッドaddPages()をオーバーライドする」」または「Dialog.createContents()Reimplementors ]はそのスーパー実装を呼び出すことができます。

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard.png

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard-addPages.png

  • [サブクラス化パターン]タブ

サブクラス化パターンは、観測された基本クラスの拡張を典型的な拡張パターンにグループ化しようとします。つまり、サブクラスを類似性によってクラスター化し、データ内のパターンを見つけます。

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-patterns-ViewerComparator.png

64
VonC

Eclipse用の自動javadocツールも探していましたが、 JAutodoc というツールが見つかりました。

このツールはコメントを非常にうまく生成し、いくつかの場所で手動でわずかな変更のみを必要とします(必要な場合)。私の意見では、このツールはコメントの作成に費やす時間の約75%を節約できます。

here にアクセスして、Eclipseとのダウンロードおよび統合の詳細な手順を参照してください。

21
Arun

このプラグインもありますが、まだ試していませんが、有望に見えます: JAutoDoc

6
StormPooper