コメントの書き方を学ぼう

学習の目標

本章では、以下の内容を学習します。

Pythonでのコメントの基本的な書き方を理解する
1行コメント（#）の使い方を習得する
複数行コメント（"""）の使い方を学ぶ
コメントを書く意味と重要性を理解する
読みやすいコメントの書き方を身につける

コメントとは何か

プログラムを書いていると、「このコードは何をしているのか」「なぜこのような処理が必要なのか」といった説明を残したくなることがあります。そんな時に使うのがコメントです。

コメントは、プログラムの実行には影響しない「メモ」のようなものです。コードの説明や注意点、後で見返した時のための覚え書きなどを書くことができます。

Pythonでコメントを書くと、実際にプログラムを実行した時にはコメント部分は無視されます。つまり、プログラムの動作に全く影響を与えずに、人間が読むための情報を残すことができるのです。

VS Codeで新しいファイル comment_practice.py を作成して、コメントの使い方を一緒に学んでいきましょう。

1行コメント（#）の使い方

基本的な1行コメント

Pythonで最もよく使われるコメントは、#（ハッシュ記号）を使った1行コメントです。#より後ろの文字は、すべてコメントとして扱われます。

# これはコメントです
print("Hello, World!")

このコードを実行してみましょう。

Hello, World!

実行結果を見ると、#から始まる行は表示されていません。これは、Pythonがコメント行を無視しているからです。

コードの横にコメントを書く

コメントは単独の行だけでなく、実際のコードの横に書くこともできます。

print("Hello, World!")  # 挨拶を表示します
age = 25  # 年齢を変数に保存
print(age)  # 年齢を表示

このように、コードの動作を説明するコメントを横に書くことで、そのコードが何をしているのかが分かりやすくなります。

実行してみると、コメント部分は表示されず、プログラムは正常に動作します。

Hello, World!
25

一時的にコードを無効にする

コメントのもう一つの便利な使い方は、一時的にコードを実行させたくない時です。削除せずに無効化したいコードの先頭に#を付けると、そのコードは実行されなくなります。

print("これは実行されます")
# print("これは実行されません")
print("これも実行されます")

実行結果は以下のようになります。

これは実行されます
これも実行されます

2行目のprint文は#でコメントアウトされているため、実行されていません。

複数行コメント（"""）の使い方

基本的な複数行コメント

長い説明や複数行にわたる注意事項を書きたい場合は、"""（ダブルクォート3つ）を使った複数行コメントが便利です。

"""
このプログラムは年齢計算を行います。
ユーザーの生まれ年を受け取り、
現在の年齢を計算して表示します。
"""

birth_year = 2000
current_year = 2024
age = current_year - birth_year
print(f"あなたの年齢は{age}歳です")

複数行コメントは、"""で始まり、"""で終わります。その間に書かれた内容は、すべてコメントとして扱われます。

実行してみると、コメント部分は無視され、年齢計算だけが実行されます。

あなたの年齢は24歳です

シングルクォートでも複数行コメント

複数行コメントは、ダブルクォート3つの代わりにシングルクォート3つ ''' を使って書くこともできます。

'''
ここも複数行コメントです。
どちらを使っても同じ効果があります。
'''

print("コメントの後のコードです")

基本的にはどちらを使っても同じですが、一般的には """ がよく使われています。

コメントを書く意味と重要性

自分のための備忘録

プログラムを書いた直後は内容をよく覚えていても、数日後や数週間後に見返すと「このコードは何をしているのだろう？」と分からなくなることがあります。そんな時、適切なコメントが書かれていると、素早く内容を思い出すことができます。

# 消費税込みの価格を計算する
price = 1000  # 商品の税抜き価格
tax_rate = 0.1  # 消費税率（10%）
total_price = price * (1 + tax_rate)  # 税込み価格を計算
print(f"税込み価格: {total_price}円")

このように、変数や計算の意味をコメントで説明しておくと、後で見返した時に理解しやすくなります。

複雑な処理の説明

計算式や処理が複雑な場合、なぜそのような処理が必要なのかをコメントで説明しておくと役立ちます。

# BMI（体格指数）を計算するプログラム
height = 1.7  # 身長（メートル）
weight = 65   # 体重（キログラム）

# BMI = 体重 ÷ 身長の2乗
bmi = weight / (height * height)
print(f"BMI値: {bmi:.1f}")

# BMIの判定基準に基づいて判定
if bmi < 18.5:
    print("やせ型です")
elif bmi < 25:
    print("普通体重です")
else:
    print("肥満です")

このように、計算式の意味や判定基準について説明しておくと、コードの意図が明確になります。

読みやすいコメントの書き方

分かりやすい表現を使う

コメントは、技術的な専門用語よりも、誰でも理解できる分かりやすい表現を使うことが大切です。

# 良い例：分かりやすい表現
user_count = 0  # ログインしているユーザーの人数

# 改善の余地がある例：専門的すぎる表現
user_count = 0  # アクティブセッション数をカウント

「何を」だけでなく「なぜ」も書く

コードを見れば「何をしているか」は分かることが多いですが、「なぜそれが必要なのか」は分からないことがあります。「なぜ」の部分をコメントで説明すると、より理解しやすくなります。

# 入力値を小文字に変換（大文字小文字の違いを気にせず比較するため）
user_input = input("果物の名前を入力してください: ").lower()

if user_input == "りんご":
    print("赤くて甘い果物ですね")
else:
    print("その果物は知りません")

コメントの量はほどほどに

コメントは大切ですが、書きすぎるとかえって読みにくくなることもあります。本当に必要な部分に絞って、適度にコメントを入れるようにしましょう。

# 適度なコメントの例
name = "太郎"
age = 20

# 成人かどうかを判定
if age >= 20:
    print(f"{name}さんは成人です")
else:
    print(f"{name}さんはまだ成人ではありません")

実際にコメントを書いてみよう

ここまで学んだコメントの書き方を使って、実際にプログラムを作成してみましょう。以下のコードを comment_example.py として作成してください。

"""
買い物の合計金額と割引を計算するプログラム
作成日: 2024年
"""

# 商品の価格設定
apple_price = 150    # りんご1個の価格
banana_price = 100   # バナナ1本の価格
orange_price = 200   # オレンジ1個の価格

# 購入数の設定
apple_count = 3   # りんごの購入数
banana_count = 2  # バナナの購入数
orange_count = 1  # オレンジの購入数

# 小計を計算
apple_total = apple_price * apple_count    # りんごの小計
banana_total = banana_price * banana_count # バナナの小計
orange_total = orange_price * orange_count # オレンジの小計

subtotal = apple_total + banana_total + orange_total  # 割引前の合計

print(f"りんご: {apple_count}個 × {apple_price}円 = {apple_total}円")
print(f"バナナ: {banana_count}本 × {banana_price}円 = {banana_total}円")
print(f"オレンジ: {orange_count}個 × {orange_price}円 = {orange_total}円")
print(f"小計: {subtotal}円")

# 割引の適用（1000円以上で10%割引）
if subtotal >= 1000:
    discount = subtotal * 0.1  # 10%割引
    final_total = subtotal - discount
    print(f"割引: -{discount}円")
    print(f"合計: {final_total}円")
else:
    print(f"合計: {subtotal}円")
    # print("1000円以上で10%割引になります")  # 宣伝メッセージ（現在は非表示）

このプログラムを実行すると、以下のような結果が表示されます。

りんご: 3個 × 150円 = 450円
バナナ: 2本 × 100円 = 200円
オレンジ: 1個 × 200円 = 200円
小計: 850円
合計: 850円

このプログラムでは、複数行コメント、1行コメント、コードの横のコメント、そしてコメントアウトの例が含まれています。各コメントがプログラムの理解にどのように役立っているかを確認してみてください。

まとめ

本章では、Pythonでのコメントの書き方について学習しました。習得できた内容は以下の通りです。

#を使った1行コメントで、簡潔な説明や一時的なコードの無効化ができるようになりました。"""を使った複数行コメントで、詳細な説明や注意事項を記述する方法を理解しました。

また、コメントを書く意味として、自分自身の備忘録や複雑な処理の説明になることを学びました。読みやすいコメントを書くためには、分かりやすい表現を使い、「なぜ」の部分も説明することが大切だと理解できました。

コメントは、プログラムをより理解しやすくするための重要なツールです。今後プログラムを書く際は、適切なコメントを心がけて、自分や他の人が読みやすいコードを作成していきましょう。