注釈(コメント)

 今回で、C言語の基礎の基礎に関する説明は終わりになります。今回は、プログラムのソースコードの中に説明書き(コメント)を残す方法について解説します。

#include <stdio.h>

int main(int argc, const char * argv[])
{

    // insert code here...
    printf("Hello, World!\n");
    return 0;
}

 前回までの上記のプログラムの中で、

// insert code here...

 このように書かれた部分があります。このように書かれたものを注釈(あるいは、コメント)と呼びます。

 コメントは、プログラムの実際の処理の中で、何らかの反応を起こすものでありません。実行時は無視されます。では、なぜコメントというものがあるかというと、「どこをどのように変更したか」や「この処理は何をしているのか」をメモとして残すために利用します。実際の開発の現場で、複数人でプログラムを構築する仕事をする際に、他の方が見ても何の処理をしているかわかるようにコメントを残すことが推奨されています。また、一人でプログラムを作る場合でも、自分で考えて実装した内容だとしても後日見ると、何のためにそう書いたのか思い出せなくなることも多々あります。そのようなときにコメントとして意図が残っていれば、確認しやすくなります。面倒ではありますが、コメントをつける癖はつけておいた方が良いでしょう。

 さて、プログラムのソースコードの中にコメントを残す書き方としては2種類あります。ひとつが、先ほどからご紹介している、スラッシュ2本を頭につける方法です。この方法は、スラッシュ2本の後ろから行末までをコメント化(無効化)します。つまり、1行ずつの対応になります。もし、複数行をコメント化したい場合は、このように記載します。

/*
main.c
山田 太郎
2012年10月25日 作成
*/

 「/*」がコメントの開始地点になり、「*/」が終了地点となります。尚、もう少し見た目を良くするために、

/***********************/
/* main.c              */
/* 山田 太郎           */
/* 2012年10月25日 作成  */
/***********************/

 このように書く方もいます。また、スラッシュ2本で、

// main.c
// 山田 太郎
// 2012年10月25日 作成

 このように記述しても構いません。ご自身の書きやすいようにコメントを書き残して下さい。

■スポンサーリンク

このページの先頭へ