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

1.7 関数の頭書きのコメント

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

■関数の頭書きのコメント例

//
// 機能 : 文字位置の取得
//
// 返り値 : 文字位置[byte](検索されなかった場合は 0を返す)
//
// 機能説明 : 文字列の中から,指定文字列を検索し位置を返す。
//
// 備考 : pStrInStr( "a#c#d#eeee", "#" ) -> 2
//     pStrInStr( "a#c#d##eeee", "##" ) -> 6
//     pStrInStr( "abcdeabcde", "AA" ) -> 0
//