コーディング規約 トップページJava コーディング規約 目次 

1.5 メソッドの頭書きのコメント

メソッドの頭書きのコメントは次のように記述する。
(1)必要のない項目は削除してもよい。
(2)キーワードと説明文の間のデリミタ(例ではコロン":")は必須である。
(3)「機能」はメソッドの説明を一行で記述する。

■メソッドの頭書きのコメント例

  //
  // 機能 : ボタンをクリックされた時の処理
  //
  // 機能説明 : ボタンをクリックされた時の処理を行う。
  //        クラス定数LOOP_COUNT回、ダイアログを表示する。
  //
  // 返り値 : なし
  //
  // 備考 : 簡単なサンプルです。
  //