【C言語】第1章第4回：C言語のコメント文：コードを読みやすくする方法

コメント文は、プログラムの読みやすさを向上させるための重要な要素です。この章では、C言語のコメント文の使い方やベストプラクティスについて詳しく解説します。

1. コメント文とは？

コメント文は、プログラムの中に記述する説明文であり、コンパイラによって無視されます。これにより、プログラムの意図や動作を他の開発者や将来の自分自身に伝えることができます。

• 1行コメント：//で始まる行にコメントを記述します。
• 複数行コメント：/*と*/で囲む形式で、複数行にわたるコメントを記述できます。

2. コメント文の記述方法

2.1 1行コメントの例

#include <stdio.h>

int main() {
    // 画面にHello, World!を表示する
    printf("Hello, World!\n");
    return 0;
}

1行コメントは、短い説明やコードの意図を記述するのに適しています。

2.2 複数行コメントの例

#include <stdio.h>

/*
 * このプログラムは、2つの数値を加算してその結果を出力します。
 */
int main() {
    int a = 5; // 最初の数値
    int b = 10; // 2番目の数値
    int sum = a + b;

    printf("The sum is: %d\n", sum); // 結果を出力
    return 0;
}

複数行コメントは、プログラム全体の概要や複雑な部分の詳細な説明に役立ちます。

3. コメント文のベストプラクティス

コメントを効果的に使うためのポイントを以下に示します：

• 簡潔に書く：冗長な説明を避け、簡潔に意図を伝える。
• 意図を説明する：コードの「何をしているか」ではなく、「なぜそれをしているか」を説明する。
• 最新の状態を保つ：コードを変更した場合は、コメントも更新する。

コメントは、他人だけでなく将来の自分にとっても有益な情報です。

4. 実践問題

以下の課題に取り組み、コメント文を活用する練習をしてください：

1. 2つの整数を入力し、それらの積を計算して出力するプログラムを作成し、コメントを追加してください。
2. 配列内の最大値を見つけるプログラムを作成し、そのアルゴリズムをコメントで説明してください。
3. 簡単な数当てゲームを作成し、各ステップにコメントを追加してわかりやすくしてください。

5. まとめ

コメント文は、コードの可読性を向上させる重要なツールです。1行コメントと複数行コメントを使い分けながら、効果的な説明を心がけましょう。コメントの活用によって、より良いプログラムを書く力が身につきます。