Pythonのコメントの書き方ガイド！1行・複数行コメントの基本と使い分け
生徒
「先生、Pythonでコードに説明を加えたいんですが、どうすればいいですか？」
先生
「それは『コメント』を使うといいですよ。コメントは、コードに説明やメモを加えるためのものです。」
生徒
「コメントって、プログラムの実行には影響しないんですか？」
先生
「その通りです。コメントはプログラムの実行には影響しません。では、Pythonでのコメントの書き方を詳しく見ていきましょう！」
1. コメントとは？
Pythonのコメントは、コードに説明やメモを加えるためのものです。コメントはプログラムの実行には影響しません。主に以下の目的で使用されます。
- コードの目的や処理内容を説明する
- 一時的にコードを無効化する（コメントアウト）
- 他の開発者や将来の自分がコードを理解しやすくする
2. 1行コメントの書き方
1行コメントは、行の先頭に#を付けて記述します。#以降の部分がコメントとして扱われ、プログラムの実行には影響しません。
# これは1行コメントの例です
print("こんにちは") # これはインラインコメントです
上記の例では、1行目と2行目の#以降がコメントとして扱われます。
3. 複数行コメントの書き方
複数行のコメントは、以下の2つの方法で記述できます。
3.1 各行に#を付ける方法
複数行にわたるコメントを記述する場合、各行の先頭に#を付けます。
# これは複数行コメントの例です
# 2行目のコメントです
# 3行目のコメントです
3.2 トリプルクォートを使用する方法
シングルクォート（'''）またはダブルクォート（"""）を3つ連続して使用することで、複数行のコメントを記述できます。ただし、これは厳密には文字列として扱われますが、変数に代入しない場合はコメントのように振る舞います。
'''
これはトリプルクォートを使用した
複数行コメントの例です
'''
print("こんにちは")
上記の例では、トリプルクォートで囲まれた部分がコメントのように扱われ、print("こんにちは")のみが実行されます。
4. コメントの使い分けと注意点
コメントを使用する際のポイントと注意点を以下にまとめます。
- 簡単な説明やメモ：1行コメント（
#）を使用 - 長文の説明や複数行のメモ：トリプルクォート（
'''または"""）を使用 - トリプルクォートの注意点：インデントを正しく揃えないとエラーの原因になることがあります
- コメントの更新：コードを変更した際は、コメントも適切に更新することが重要です
5. コメントの活用例
以下に、コメントを活用した例を示します。
# ユーザーの年齢を取得し、表示するプログラム
age = input("年齢を入力してください：") # ユーザーからの入力を受け取る
print("あなたの年齢は", age, "歳です") # 入力された年齢を表示する
このように、コードの各部分にコメントを加えることで、処理内容が明確になり、他の人や将来の自分が理解しやすくなります。
6. コメントのベストプラクティス
コメントを効果的に活用するためのベストプラクティスを以下に示します。
- 明確で簡潔なコメント：コメントは簡潔でわかりやすく記述しましょう
- コードの意図を説明：なぜそのコードを書いたのか、意図を明確にしましょう
- 不要なコメントの削除：古くなったコメントや不要なコメントは削除しましょう
- 一貫性のあるスタイル：コメントの書き方を統一し、読みやすさを保ちましょう
まとめ
Pythonのコードに説明を加えるためのコメントは、読みやすさや理解しやすさを高めるうえで欠かせない存在です。とくに初心者にとっては、処理の意図やプログラムの流れを整理する手助けとなり、将来コードを見返したときにも役立ちます。
本記事で学んだように、Pythonには#を使った1行コメントと、トリプルクォートを使った複数行コメントという2つの主要な方法があります。短い説明を加えるときには1行コメントを、まとまった説明や補足を加えるときには複数行コメントが便利です。コードに沿って丁寧に説明を書くことで、読み手へ伝えたい意図や背景がしっかり伝わるようになります。
また、コメントはただ書けばよいものではなく、常にコードと内容を一致させることが重要です。コードが変更されたときは、必ずその意図や振る舞いに合わせてコメントも更新することが求められます。過去の説明が残ったままになっていると、誤解を生みやすく、プログラムの理解を妨げる原因にもなるため注意が必要です。
プログラム学習を進めるうえでも、コメントの使い分けや整理は習慣づけておくと大きな助けになります。特に長いプログラムでは、処理の意味をまとめたメモや、仮のテストで使う部分をコメントアウトすることが多くなり、可読性の高いコードを書くための基礎となります。
ここでは、今回学んだ内容を反映したシンプルなサンプルコードをまとめとして掲載します。Pythonのコメントを効果的に使うためのイメージづくりにぜひ活用してみてください。
サンプルプログラム（コメントの使い方の振り返り）
# ユーザーの名前を入力して挨拶を返すサンプル
# ここでは1行コメントを使って処理の目的を説明します
name = input("お名前を入力してください：") # ユーザーから名前を取得
"""
以下の処理は、複数行コメントを使った説明です。
複数行で補足を入れたい場合や、
まとめて注釈を書きたい場合に便利です。
"""
print("こんにちは、" + name + "さん！") # あいさつを表示
生徒
「先生、今日 Python のコメントの使い方を学んでみて、コードがすごく読みやすくなるって実感しました！」
先生
「その気づきはとても大切ですね。コメントはコードを書くうえでの思いや意図を言葉として残せるから、プログラムの理解に大きく役立つんですよ。」
生徒
「1行コメントと複数行コメントを使い分けると、読み手に優しい説明ができるのも良いと思いました。」
先生
「そうですね。特に複数行の説明を書けるトリプルクォートは、補足や背景を書くときにとても便利です。ただし、コードの変化に合わせてコメントも更新する習慣を忘れないようにしましょう。」
生徒
「はい！これからはコメントもうまく使って、読みやすいコードを意識して書いてみます！」
先生
「その調子です。コメントは奥が深いですが、基本を押さえておくことで自然と質の高いコードへつながっていきますよ。」
この記事を読んだ人からの質問
