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

1.9 メソッド中のコメント

【A HotDocument】で生成されるメソッド定義書に反映させたいコメントは,(/// …),(//// …)のように記述する。

メソッド定義書の中の段下げは,(/)の数により深くすることができる。

■メソッド中のコメントの例

{
  int i;
  String Buf;
 
   /// 固定文字列を代入する
   Buf = "回目のボタンの文字列";

   /// 以下の処理を、LOOP_COUNT回行う
   for (i = 0; i < LOOP_COUNT; i++)
   {
    String MessageString;

    //// 文字列を連結してダイアログに表示する
    MessageString = i + Buf;
    MessageBox.Show(MessageString);
   }
}