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

1.8 関数定義のコメント

関数の定義は次のように記述する。
(1)関数の型，関数名を記述する。
(2)次の行以降，引数の後にコメントを記述する。

■関数定義のコメントの例（ANSIスタイル）

char *cm_getMessage(
　char *msg_filename,　// メッセージ定義ファイル名
　int msg_number)　　　// メッセージ番号
{
  int i;
}

■関数定義のコメントの例（K&Rスタイル）

char *cm_getMessage(msg_filename, msg_number)
　　char *msg_filename;　// メッセージ定義ファイル名
　　int msg_number;　　　// メッセージ番号
{
  int i;
}