| ページ一覧 | ブログ | twitter |　 書式 | 書式(表) |

MyMemoWiki

Javadocでパッケージにコメントをつける

提供: MyMemoWiki
2020年2月15日 (土) 08:20時点におけるPiroto (トーク | 投稿記録)による版
ナビゲーションに移動 検索に移動

Javadocでパッケージにコメントをつける

JavaJavaDoc

http://docs.oracle.com/javase/jp/6/technotes/tools/windows/javadoc.html

[ソースファイルの処理]

方法は以下の2つ

package-info.java

  • パッケージ宣言、パッケージ注釈、パッケージコメント、および Javadoc タグを格納できます。
  • JDK 5.0 で導入されたものであり、package.html よりも推奨されています。
  1. /** 
  2.  * Provides the classes necessary to create an applet and the classes an applet uses 
  3.  * to communicate with its applet context.
  4.  * <p> 
  5.  * The applet framework involves two entities:
  6.  * the applet and the applet context.An applet is an embeddable window (see the 
  7.  * {@link java.awt.Panel} class) with a few extra methods that the applet context   
  8.  * can use to initialize, start, and stop the applet.
  9.  * 
  10.  * @since 1.0 
  11.  * @see java.awt 
  12.  */ 
  13.  package java.lang.applet;

package.html

  • ソースディレクトリのパッケージ直下に、package.html というファイルを置く。
  • 格納できるのはパッケージコメントと Javadoc タグだけです。パッケージ注釈は格納できません。
  1. <HTML> 
  2.    <BODY> 
  3.      Provides the classes necessary to create an applet and the classes an applet uses to communicate with its applet context.
  4.      <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 
  5.    </BODY> 
  6.  </HTML>
「https://www.typea.info/tips_/index.php?title=Javadocでパッケージにコメントをつける&oldid=4119」から取得

© 2006 矢木浩人