コーディング規約 トップページC/C++ コーディング規約 目次 

1.10 関数中のコメント

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

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

■関数中のコメントの例

{
  int nsrc = strlen(srcstr);
  int ntar = strlen(tarstr);
  int i;
 
  /// 文字列の長さ分ループする
  for (i = 0; i < ntar; i++)
    //// ヒットした場合カウントアップし,それを返り値とする
    if (strncmp(tarstr+i, srcstr, nsrc) == 0)
      return i+1;
  return 0;
}