Java/JavaDoc luckey!!!! - memo random

Java

JavaDoc? †

↑

javaDocとは †

Javaのクラスの仕様、Javaのメソッドの仕様をjavaのソースからHTMLに生成する機能
※ソースの説明書を出力する機能だと思えば良い。

以下標準のJavadoc

↑

使い方 †

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

    2.   * クラスの説明.

    3.   * <pre></pre>JavadocにはHTMLタグを使用することができる。

    4.   * @param 総称型パラメータの説明

    5.   * @param 引数の数だけ指定

    6.   * @author 作成者

    7.   * @version 1.0

    8.   * @since 1.0

    9.   */

    10.  public class JavadocSample<T1, T2> {

    11.  

    12.    /**

    13.     * 非推奨メソッド。

    14.     * @deprecated このメソッドは非推奨です。

    15.     * @param t 説明

    16.     * @throws 例外の説明

    17.     */

    18.    String deprecatedMethod(int t) {

    19.    }

    20.  

    21.    /**

    22.     * メソッドの説明。

    23.     * @param t 説明

    24.     * @return String型の値

    25.     * @since 1.5

    26.     */

    27.    public String add(T1 t) {

    28.      return null;

    29.    }

    30.  }
トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2018-08-31 (金) 00:09:59 (2305d)