2020年4月17日金曜日

C++のコメントの書き方

C++のコメントの書き方を備忘する。

■関数コメント
// 関数:関数名を書く。例:IsHoge(Hoge hoge)
// 引数:引数の意味を書く。例:Hoge hoge:Hoge管理用オブジェクト
// 戻値:戻り値の意味を書く。例:true:hogeが有る、false:hogeが無い
// 詳細:関数の詳細を書く。例:hogeの有無を検証する

参考サイト
https://qiita.com/inabe49/items/23e615649e8539d857a8