web-dev-qa-db-ja.com

EclipseでJavaDocをパッケージに簡単に追加できますか?

Javadocを使用して、クラスとメソッドを文書化しています。パッケージにも概要情報を追加したいと思います。 /**<Enter>と入力すると、Eclipseがクラスまたはメソッドごとに一致するDoc Commentのスタブを作成する方法が気に入っています。 Eclipseには package.html file を生成する簡単な方法もありますか?

40
Hanno Fietz

4年後の更新(2013年10月)

javabeangrinder 's answer (賛成)は次のトリックについて言及しています:

既存のパッケージにpackage-info.Javaファイルを作成するには:

  • package-info.Javaが必要なパッケージを右クリックします。
  • new->packageを選択します。
  • Create package.info.Javaチェックボックスをオンにします。
  • Finishをクリックします

元の回答(2009年5月)

Package.htmlファイルを簡単に作成するためのテンプレートやウィザードはありません。

mmyers がコメントで述べたように、Java1.5なので、作成する正しいファイルは package-info.Java になります。
このファイルは、javadocsだけでなく パッケージレベルの注釈 にも使用できます(ここでは ここに示されています )。

package-info.Javaを作成するためのウィザードを要求するための opened Bug(#86168) があります(クラスウィザードではpackage-info name)。

そのトピックに関する考察は... 2005年以来続いています!問題は、ソリューションが1.4コードにも役立つ方法で実装される必要があることです。

現在の回避策は、textファイルとしてpackage-info.Javaを作成することです。
それ以降、package-info.Javaは通常のJavaクラスとして動作し、Eclipseはpackage-info.classファイルを出力フォルダーに配置します。
Javadocsは、package-info.Javaファイルではなく、package.htmlを使用して正しく構築されています。

alt text
(ソース: developpez.com


注( Strawberry のコメントに応じて):

両方wishaパッケージ内のパッケージ概要のプレビュー- Javadocビューのinfo.Java

これまでのところ、パッチは提案/実装されていません。
単にその機能を追加するための十分な要求はありません。

51
VonC

Eclipseの場合

Package-info.Javaはクラスの有効な識別子ではないため、Eclipseでクラスとして作成することはできません。

新しいパッケージを作成するときに、package-info.Javaが必要かどうかをチェックするチェックボックスがあることがわかりました。

既存のパッケージにpackage-info.Javaファイルを作成するには:

  1. Package-info.Javaが必要なパッケージを右クリックします。
  2. New-> packageを選択します。
  3. [package.info.Javaの作成]チェックボックスをオンにします。
  4. 完了をクリックします
15
javabeangrinder

JAutodocプラグインは、これだけでなく、他のすべてのドキュメントニーズにも対応できます。プラグインをインストールして設定し、パッケージを右クリックしてJAutodoc>パッケージの追加Javadocをクリックします

.Javaまたは.htmlパッケージのドキュメントで使用できる構成とテンプレートがあります。

このプラグインは、Javadocのすべてのニーズを標準化する優れた機能を備えています。

http://jautodoc.sourceforge.net/

13
NathanChristie

Package.htmlファイルを作成するように見えるプラグインがあります。私はそれを使用していませんが、ここに着陸した人はそれが役に立つと思うかもしれません。

http://sourceforge.net/projects/package-javadoc/

3
gMale