40

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

4

4 に答える 4

51

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

javabeangrinder回答(賛成)は次のトリックに言及しています:

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

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

元の回答(2009年5月)

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

mmyersがコメントで述べたように、以来Java1.5、作成する正しいファイルはですpackage-info.java
このファイルは、javadocsだけでなく、パッケージレベルのアノテーションにも使用できます(ここに示すように)。

作成するためのウィザードを要求するための未解決のバグ(#86168)がありますpackage-info.java(クラスウィザードでは名前が許可されていないためpackage-info)。

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

現在の回避策は、をファイルpackage-info.javaとして作成することです。 その時点から、通常のJavaクラスとして動作し、Eclipseはファイルを出力フォルダーに配置します。 は、ファイルではなく、を使用して正しくビルドされます。text
package-info.javapackage-info.class
Javadocspackage-info.javapackage.html

代替テキスト
(出典:developpez.com


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

どちらも、Javadocビューのpackage-info.javaにあるパッケージの概要のプレビューを希望しています。

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

于 2009-05-21T18:31:08.057 に答える
15

日食で

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

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

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

  1. package-info.java が必要なパッケージを右クリックします。
  2. 新規→パッケージを選択。
  3. [package.info.java の作成] チェック ボックスをオンにします。
  4. [完了] をクリックします
于 2013-02-05T13:12:49.280 に答える
13

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

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

このプラグインは、Javadoc のすべてのニーズを標準化するという優れた機能も備えており、多くのカスタマイズが可能です。

http://jautodoc.sourceforge.net/

于 2011-01-14T21:25:23.740 に答える
3

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

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

于 2010-01-06T18:07:55.047 に答える