Javadocでパッケージにコメントをつける
ナビゲーションに移動
検索に移動
Javadocでパッケージにコメントをつける
http://docs.oracle.com/javase/jp/6/technotes/tools/windows/javadoc.html
方法は以下の2つ
package-info.java
- パッケージ宣言、パッケージ注釈、パッケージコメント、および Javadoc タグを格納できます。
- JDK 5.0 で導入されたものであり、package.html よりも推奨されています。
/** * Provides the classes necessary to create an applet and the classes an applet uses * to communicate with its applet context. * <p> * The applet framework involves two entities: * the applet and the applet context.An applet is an embeddable window (see the * {@link java.awt.Panel} class) with a few extra methods that the applet context * can use to initialize, start, and stop the applet. * * @since 1.0 * @see java.awt */ package java.lang.applet;
package.html
- ソースディレクトリのパッケージ直下に、package.html というファイルを置く。
- 格納できるのはパッケージコメントと Javadoc タグだけです。パッケージ注釈は格納できません。
<HTML> <BODY> Provides the classes necessary to create an applet and the classes an applet uses to communicate with its applet context. <p> The applet framework involves two entities:the applet and the applet context.An applet is an embeddable window (see the {@link java.awt.Panel} class) with a few extra methods that the applet context can use to initialize, start, and stop the applet.@since 1.0 @see java.awt </BODY> </HTML>
© 2006 矢木浩人
