コメントのルール - Research Life @CHA

プログラム作成時に用いるコメントの書き方のルール（俺流）

コメントの書き方は統一したほうが読みやすいし，かっこいいよね！

プログラムの先頭に書くやつ

右側にも閉じるための「*」が書きたかったけど，位置がそろわなかったからここでは書いていません．

/*****************************************
 * プログラム名: Hello World
 * 機能: "Hello World!''と出力する
 * 作成者: research life
 * 備考: コンパイルの仕方とか
 * 改訂更新履歴:
 *   -最後に改行を入れた 2011/2/1
 *****************************************/

セクションの先頭に書くやつ

/*-------------------- main関数の始まり --------------------*/

/*-------------------- 関数のプロトタイプ宣言部 --------------------*/

関数名とかクラス名とか

/*---------------------------------------*
 * swap関数
 * -引数の2変数の値を入れ替える
 *---------------------------------------*/

大まかなまとまりの説明

/*
 * 配列のデータを降順にソートする
 */

ちょっと小さなまとまりの説明とか区切り

/***** 配列aについて *****/

複数行をまとめて説明

/* aとbの値を入れ替える */

1行を説明

//初期値設定

---