Programming 1 Home
コメントの書き方
提出された課題にまともにコメントされたものが余りにも少なかったので。
自分以外にも読むことの出来るコメントの書き方を解説しようかと。
コメントの使い方
コメントはソースコードに書いてある処理の内容を説明するものである。
基本的には処理の内容だが、例えば、以下のような使い道が考えられる。
・ 処理の内容を説明
・ 扱うデータの内容を説明
・ 関数の引数と戻り値など説明
コメントはソースを読んだだけでは分からないであろうことを説明するものだ。
例えば、以下は良くないコメントの例である。
tmp = a[i]; /* tmp に a[i] を代入 */
a[i] = a[j]; /* a[i] に a[j] を代入 */
a[j] = tmp; /* a[j] に tmp を代入 */
このコメントは以下であると良い。
tmp = a[i]; /* a[i] と a[j] の値を入れ替える */
a[i] = a[j];
a[j] = tmp;
プログラムの内容を知らない人のとっては、プログラムが何を目的としているのかや、
プログラムのその部分で何をしようとしているのかは重要な情報である。
コメントの使用例
ごく簡単にだがコメントの入れ方の例を示す。
簡単なプログラムの場合ココまでのコメントは入れないこともある。
また人にソースを見せる場合はもっと詳細なコメントを入れることもある。
/*****************************************************************************
sort.c : 数字の並べ替えのれんしゅう
2001/10/15 by Watanabe Takehito
*****************************************************************************/
#include /*==========================================================================*/
#define SIZE 5 /* 並べ替える数字の個数 */ /*==========================================================================*/
/* sort : 数字の並べ替えをする */ /* 引数 : a - 並べ替える数字を入れた配列( 長さ SIZE ) */ /* 戻値 :
なし */ /*==========================================================================*/
void sort(int a[]) { int i, j, tmp; for (i = 0; i < SIZE-1; i++) { /*
並べ替えをするループ */ for (j = i+1; j < SIZE; j++) /* i 以降から一番小さいのを探す */ if
(a[i] > a[j]) { tmp = a[i]; /* i より j が小さければ入れ替え */ a[i] = a[j]; a[j]
= tmp; } } } /*==========================================================================*/
/* main : プログラムの開始地点 */ /*==========================================================================*/
int main() { int a[SIZE] = { 10, 5, -1, -12, 17 }; int i; sort(a); /* 配列
a の数字を並べ替える */ for (i = 0; i < SIZE; i++) /* 配列 a の数字を表示 */ printf("%d\n",
a[i]); return 0; }
2001/10/15 by Watanabe Takehito