Java/JavaDoc の変更点 luckey!!!! - memo random

#author("2018-08-30T23:58:26+09:00","ldap:pandora"," pandora")
#author("2018-08-31T00:09:59+09:00","ldap:pandora"," pandora")
[[Java]]
* ''JavaDoc'' [#k33d40dc]
#contents
* javaDocとは [#gd7607a7]
 Javaのクラスの仕様、Javaのメソッドの仕様をjavaのソースからHTMLに生成する機能
 ※ソースの説明書を出力する機能だと思えば良い。
以下標準のJavadoc
-https://docs.oracle.com/javase/jp/7/api/

* 使い方 [#if94fdc1]
 コメントを記述する時に、Javadocタグ、決まった定型文を埋め込む。
- Javadocタグ(一部)
|タグ|記述内容|h
|@author|開発者名を記述する。|
|@deprecated|廃止されたクラス やメソッドに付けられる。|
|@exception|メソッドが投げる例外クラスとその説明を記述する。|
|@param|メソッドの引数や総称型のパラメータを記述する。|
|@return|メソッドの戻り値を記述する。|
|@see|関連する他のメソッドまたはクラスを記述する。|
|@since|クラスまたはメソッドの導入されたバージョンを記述する。|
|@version|クラスまたはメソッドのバージョンを記述する。|
|@serial|デフォルトで直列化可能フィールドのdocコメントで使用する。|

- 使用例
#highlighter(java,number){{
/**
  * クラスの説明.
  * <pre>
  * ピリオド(.)または句点(。)で終わるところまでが、
  * クラス一覧の概要に説明されるところであり、
  * ピリオド以降は説明の概要には含まれず、クラスの説明に含まれる。
  * このように、JavadocにはHTMLタグを使用することができる。
  * </pre>
  * @param <T1> 総称型パラメータの説明
  * @param <T2> 総称型パラメータの説明
  * @author Wikipedian
  * @author Second author
  * @version 1.6
  * <pre></pre>JavadocにはHTMLタグを使用することができる。
  * @param 総称型パラメータの説明
  * @param 引数の数だけ指定
  * @author 作成者
  * @version 1.0
  * @since 1.0
  */
 public class JavadocSample<T1, T2 extends List> {
 public class JavadocSample<T1, T2> {
 
   /**
    * @serial 直列化可能データの説明
    */
   private int x;
 
   /**
    * Validates a chess move.
    * @author John Doe
    * @param theFromFile File of piece being moved
    * @param theFromRank Rank of piece being moved
    * @param theToFile   File of destination square
    * @param theToRank   Rank of destination square
    * @return true if a valid chess move or false if invalid
    */
   boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank)
   {
      //...
   }
 
   /**
    * 非推奨メソッド。
    * @deprecated このメソッドは非推奨です。
    * @param t 説明
    * @throws SomeException 例外の説明
    * @throws 例外の説明
    */
   String deprecatedMethod() {
     //...
   String deprecatedMethod(int t) {
   }
 
   /**
    * メソッドの説明。
    * @param t 説明
    * @throws SomeException 例外の説明
    * @throws Exception 例外の説明
    * @return String型の値
    * @since 1.5
    * @see "関連"
    * @see <a href="http://www.example.com/">Example</a>
    * @see String#equals(Object) equals
    */
   String add(T1 t) throws SomeException, Exception {
     
   public String add(T1 t) {
     return null;
   }
 }

}}

トップ   編集 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS