Javadocの書き方

Javadocの書き方

Javadocの書き方についてメモです。

/**
 * メイン処理を行います.
 * @author M.Takahashi
 * @since  2016.06.01
 * @param args プログラム引数
 */
public static void main(String[] args) {

}

説明文はピリオドで終わります。

@authorは作成者です。

@sinceは日付を記入します。

@paramは引数の説明を記入します。複数あれば複数記述します。

以下のようにメソッドが戻り値を返す時は@returnを使います。

/**
  * 時間を取得します.
  * @author M.Takahashi
  * @since 2016.06.01
  * @return 時間
  */
public String getHh() {
  return hh;
}

@returnは戻り値を表します。

高橋

KHI入社して退社。今はCONFRAGEで正社員です。関西で140-170/80～120万から受け付けております^^
得意技はJS(ES6),Java,AWSの大体のリソースです
コメントはやさしくお願いいたします^^
座右の銘は、「狭き門より入れ」「願わくは、我に七難八苦を与えたまえ」です^^