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

MyMemoWiki

「Javadocでパッケージにコメントをつける」の版間の差分

提供: MyMemoWiki
ナビゲーションに移動 検索に移動
(ページの作成:「==Javadocでパッケージにコメントをつける== [Java][JavaDoc] http://docs.oracle.com/javase/jp/6/technotes/tools/windows/javadoc.html [http://docs.oracl…」)
 
1行目: 1行目:
 
==Javadocでパッケージにコメントをつける==
 
==Javadocでパッケージにコメントをつける==
[Java][JavaDoc]
+
[[Java][JavaDoc]]
  
 
http://docs.oracle.com/javase/jp/6/technotes/tools/windows/javadoc.html
 
http://docs.oracle.com/javase/jp/6/technotes/tools/windows/javadoc.html
  
[http://docs.oracle.com/javase/jp/6/technotes/tools/windows/javadoc.html#processingofsourcefiles ソースファイルの処理]
+
[[http://docs.oracle.com/javase/jp/6/technotes/tools/windows/javadoc.html#processingofsourcefiles ソースファイルの処理]]
  
 
===方法は以下の2つ===
 
===方法は以下の2つ===
13行目: 13行目:
 
   * Provides the classes necessary to create an applet and the classes an applet uses  
 
   * Provides the classes necessary to create an applet and the classes an applet uses  
 
   * to communicate with its applet context.
 
   * to communicate with its applet context.
   * <p>
+
   * &lt;p&gt;
 
   * The applet framework involves two entities:
 
   * The applet framework involves two entities:
 
   * the applet and the applet context.An applet is an embeddable window (see the  
 
   * the applet and the applet context.An applet is an embeddable window (see the  
27行目: 27行目:
 
*ソースディレクトリのパッケージ直下に、package.html というファイルを置く。
 
*ソースディレクトリのパッケージ直下に、package.html というファイルを置く。
 
*格納できるのはパッケージコメントと Javadoc タグだけです。パッケージ注釈は格納できません。
 
*格納できるのはパッケージコメントと Javadoc タグだけです。パッケージ注釈は格納できません。
  <HTML>
+
  &lt;HTML&gt;
     <BODY>
+
     &lt;BODY&gt;
 
       Provides the classes necessary to create an applet and the classes an applet uses to communicate with its applet context.
 
       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  
+
       &lt;p&gt; 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>
+
     &lt;/BODY&gt;
   </HTML>
+
   &lt;/HTML&gt;

2020年2月15日 (土) 08:03時点における版

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

[[Java][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>