コメントの書き方：プログラムに説明を付ける#
はじめに#
今回は、プログラミングの重要な基本スキルである「コメント」の書き方について学んでいきます。
コメントとは、プログラムの中に書く「メモ書き」のようなものです。コメントはプログラムの実行には影響せず、人間が読むための説明文として機能します。これからプログラミングを学ぶ皆さんにとって、コメントの使い方を早い段階で学ぶことは非常に重要です。
コメントとは？#
コメントは、プログラムの中に書かれた説明や注釈のことです。コードを書いた後、時間が経つと「なぜこのコードを書いたのか？」「何をしようとしていたのか？」を忘れてしまうことがよくあります。コメントを使えば、そのような情報を残しておくことができます。
特に重要なのは、コメントはコンピュータによって無視されるという点です。つまり、コメントはプログラムの動作には何の影響も与えません。コメントは純粋に人間のためのものなのです。
Pythonでのコメントの書き方#
Pythonでは、主に2種類のコメントの書き方があります。
1. 単一行コメント（#を使う方法）#
もっとも一般的なのは、シャープ記号（#）を使った単一行コメントです。#から行末までがコメントとして扱われます。
Google Colabで新しいノートブックを作成します。タイトルは「コメントの書き方」としましょう。
それでは、以下のコードを入力して実行してみましょう。
# この行はコメントです。実行されません。
print("Hello, World!") # この部分もコメントです。
実行結果：
Hello, World!
見ての通り、#マークで始まる部分は実行されず、print()関数の部分だけが実行されました。
単一行コメントは行の先頭に書くこともできますし、コードの後ろに書くこともできます。どちらの場合も、#から右側の部分がすべてコメントになります。
2. 複数行コメント（三重引用符を使う方法）#
Pythonで複数行に渡るコメントを書く場合、三重引用符（'''または"""）を使うことができます。これは厳密にはコメントではなく「ドキュメント文字列（docstring）」と呼ばれるものですが、コメントのように利用することもできます。
以下のコードを実行してみましょう。
'''
これは複数行コメントです。
このように、複数の行に
わたってコメントを書くことができます。
'''
print("Hello, World!")
"""
三重引用符は、シングルクォート(')でもダブルクォート(")でもOKです。
どちらを使っても機能は同じです。
"""
print("コメントの後のコードは実行されます。")
実行結果：
Hello, World!
コメントの後のコードは実行されます。
三重引用符で囲まれた部分はすべてコメント扱いとなり、実行されません。
コメントの活用方法#
コメントは様々な目的で使用されますが、以下のような使い方が一般的です。
1. コードの説明#
コードが何をしているのか、どのような目的で書かれたのかを説明するために使います。
# ユーザーの年齢を計算する
birth_year = 1990
current_year = 2025
age = current_year - birth_year
print(f"あなたの年齢は{age}歳です。")
実行結果：
あなたの年齢は35歳です。
2. コードの区切り#
コードのセクションを分けて、読みやすくするために使います。
# --- データの準備 ---
name = "田中"
age = 30
location = "東京"
# --- データの表示 ---
print(f"名前: {name}")
print(f"年齢: {age}")
print(f"住所: {location}")
実行結果：
名前: 田中
年齢: 30
住所: 東京
3. 一時的なコードの無効化#
テストやデバッグの際に、一部のコードを一時的に実行しないようにするために使います。これは「コメントアウト」と呼ばれるテクニックです。
print("この行は実行されます。")
# print("この行はコメントアウトされているので実行されません。")
print("この行も実行されます。")
実行結果：
この行は実行されます。
この行も実行されます。
複数行をコメントアウトする場合は、三重引用符を使うと便利です。
print("この行は実行されます。")
'''
print("これらの行は")
print("すべてコメントアウトされています。")
print("実行されません。")
'''
print("この行は実行されます。")
実行結果：
この行は実行されます。
この行は実行されます。
4. コードの動作の説明#
特に複雑なコードや、初心者には分かりづらい部分には、詳しい説明を加えると良いでしょう。
# for文を使って1から5までの数字を表示する
for i in range(1, 6): # range(1, 6)は1から5までの数字の列を生成する
print(i)
実行結果：
1
2
3
4
5
効果的なコメントの書き方#
コメントは単に「存在する」だけでは意味がありません。効果的なコメントを書くためのいくつかのヒントを紹介します。
1. 明確で簡潔に#
コメントは短く、明確に書きましょう。不必要に長いコメントは読みづらくなります。
# よいコメント例：
# ユーザーの年齢を計算する
age = 2025 - 1990
# 冗長なコメント例：
# 現在の年から生まれた年を引いて、その結果をage変数に代入することで
# ユーザーの年齢を計算しています。計算には減算演算子を使用しています。
age = 2025 - 1990
2. 「なぜ」を説明する#
コードを見れば「何をしているか」は分かることが多いですが、「なぜそうしているのか」は分かりません。特に重要な決断や複雑なロジックには、その理由を説明するコメントを付けましょう。
# 税込価格を計算（2025年現在の消費税率は10%）
price = 1000
tax_rate = 0.1
total_price = price * (1 + tax_rate)
3. 定期的に更新する#
コードを変更したら、関連するコメントも更新することを忘れないでください。古いコメントはコードの理解を妨げる原因になります。
# 間違ったコメント例（コードが変更されているのにコメントが更新されていない）
# 消費税率8%で計算
tax_rate = 0.1 # 実際は10%になっている
4. 自明なことには書かない#
誰が見ても明らかなことにコメントを付ける必要はありません。
# 必要のないコメント例
x = x + 1 # xに1を足す
コメントを使った実践例#
では、ここまで学んだことを活かして、コメントを効果的に使ったプログラム例を見てみましょう。
# 買い物の合計金額を計算するプログラム
# --- 商品データの準備 ---
# 商品名と価格のリスト
item1_name = "りんご"
item1_price = 150
item1_quantity = 3 # 個数
item2_name = "バナナ"
item2_price = 100
item2_quantity = 5 # 個数
# --- 計算処理 ---
# 各商品の小計を計算
item1_subtotal = item1_price * item1_quantity
item2_subtotal = item2_price * item2_quantity
# 合計金額
total = item1_subtotal + item2_subtotal
# --- 結果表示 ---
print(f"{item1_name}: {item1_price}円 × {item1_quantity}個 = {item1_subtotal}円")
print(f"{item2_name}: {item2_price}円 × {item2_quantity}個 = {item2_subtotal}円")
実行結果：
りんご: 150円 × 3個 = 450円
バナナ: 100円 × 5個 = 500円
この例では、プログラムの概要、日付、セクションの区切り、処理の説明など、様々な種類のコメントが使われています。これらのコメントによって、コードの目的や処理の流れが明確になり、初めて見る人でも理解しやすくなっています。
まとめ#
この記事では、Pythonにおけるコメントの書き方と活用方法について学びました。
- コメントはプログラム内の説明文で、実行には影響しない
#を使って単一行コメントを書く- 三重引用符（
'''または"""）で複数行コメントを書く - コメントの主な用途は、コードの説明、区切り、一時的な無効化など
- 効果的なコメントは明確で簡潔であり、コードの「なぜ」を説明する
プログラミング初心者のうちは、多めにコメントを書く習慣をつけるとよいでしょう。自分が書いたコードでも、数週間後には「これは何をするコードだったっけ？」と忘れてしまうことがよくあります。適切なコメントがあれば、そのような時に大きな助けになります。
また、他の人とコードを共有する場合や、チームで開発を行う場合には、コメントはさらに重要になります。自分が当たり前だと思っていることでも、他の人にとっては分かりづらいことがあるからです。