Javadoc

javadoc.md

Javadoc

項目

annotation	description
@author	プログラムの作成者
@version	作成したプログラムのバージョン
@param	メソッドの引数の説明
@return	メソッドの戻り値の説明

例

/**
 * @author Some one
 * @version 0.0.1
 */
 
 /**
  * Javadoc解説用のメインクラス
  */
public class Hello {
    /**
     * mainメソッド
     * @param args 使用しない
     */
    public static void main(String[] args) {
        // ディスプレイに表示するためのメソッド
        System.out.println(this.hello());
    }
    /**
     * 挨拶を出力する
     * @return 挨拶の文字列
     */
    private string hello() {
      return "Hello Java!"
    }
}