このページで解説している内容は、以下の YouTube 動画の解説で見ることができます。
【Python入門】コメント文の書き方（VSCode）
コメント文の書き方（VSCode）
ここでは、VSCode を使った Python プログラムにおけるコメント文の書き方について、基本的な考え方と具体的な記法を順を追って解説します。コメントは、プログラムの説明や一部コードの無効化に使われ、実行時には無視されるため、コードの読みやすさと保守性を向上させる重要な役割を果たします。
コメントはコードの実行に影響せず、プログラムの意図や処理内容を人間に説明するために用いられます。ここでは、ブロックコメントとインラインコメント、複数行コメント、そして三重クォート文字列を使ったコメントアウトの代替手段について説明します。
プログラムのダウンロード
「ダウンロード」から、サンプルプログラムがダウンロードできます。ファイルは、ESET Endpoint Securityでウイルスチェックをしておりますが、ダウンロードとプログラムの実行は自己責任でお願いいたします。
１．コメント文の基本概念
Python では、# を使って行末までをコメントとして扱います。コメントは次の 2 種類に大別されます。
| 種類 | 記法例 | 用途・目的 |
|---|---|---|
| ブロックコメント | # 長方形の面積を計算して表示する | 複数行のコードの前に、コード全体の意図や説明を書く |
| インラインコメント | print("Average:", average) # 平均点を表示 | 同一行のコードについて、補足説明を記述する |
ブロックコメントは、処理の全体的な意図を説明するのに適しており、インラインコメントは、個別の式や処理に対する簡単な注釈として使用します。
２．ブロックコメントの例
たとえば、長方形の面積を計算して表示するプログラムを作成する場合、ブロックコメントを用いてその処理内容を説明できます。
comments1.py
# 長方形の面積を計算して表示する
width = 10
height = 5
area = width * height
print("Area:", area)この例では、最初の行にブロックコメントを記述し、続く行で幅と高さを定義、面積を計算しています。実行結果は以下のようになります。
実行結果
Area: 50３．インラインコメントの例
同じ内容でも、各行に対してインラインコメントを追加することで、細かい処理の説明が可能です。以下は別の例として、3 回のテストでの平均点を計算するプログラムです。
comments2.py
score1 = 88 # 1回目のテストの点数
score2 = 92 # 2回目のテストの点数
score3 = 79 # 3回目のテストの点数
average = (score1 + score2 + score3) / 3 # テストの合計点数を3で割り平均点を算出
print("Average:", average) # 平均点を表示実行結果は以下のようになります（実際の数値は点数に応じて変わります）。
実行結果
Average: 86.33333333333333４．複数行のコメントとコメントアウトの練習
VSCode では、複数行のコメントを各行の先頭に # を記述して作成します。たとえば、以下の例は、デバッグ用に一時的に無効化したいコードをコメントアウトする際のサンプルです。
comments3.py
# 以下のコードは、一時的にコメントアウトして動作を検証するためのものです。
# print("Debug: Score1 =", score1)
# print("Debug: Score2 =", score2)
# print("Debug: Score3 =", score3)
print("Program execution continues here") この例では、3 行の print 文がコメントアウトされ、実行結果には「Program execution continues here」だけが表示されます。VSCode では、これらの行をまとめて選択し、Ctrl + K その後 Ctrl + C を入力することでコメントアウト、解除は Ctrl + K と Ctrl + U を使用できます。
５．三重クォート文字列によるコメントアウト（代替手段）
VSCode にコメントアウトの機能が備わっていない場合など、複数行のコードを手軽に無効化したい場合には、三重クォート文字列（''' または """）を使う方法もあります。ただし、これは本来複数行文字列を書くための文法ですので、あくまで代替手段として利用してください。
三重クォートを使う前のプログラム例
comments4.py
print("Line 1")
print("Line 2")
print("Line 3")
print("Only this line is executed")三重クォートで囲んでコメントアウトした場合
'''
print("Line 1")
print("Line 2")
print("Line 3")
'''
print("Only this line is executed")この場合、三重クォートで囲まれた部分は実行されず、「Only this line is executed」とだけ表示されます。
まとめ
VSCode を活用することで、Python のコメント文は以下のように使い分けることができます。
- ブロックコメントは、コード全体の意図や大きな処理の説明に適しており、
#から始め、処理前に配置します。 - インラインコメントは、個々の行に対する補足説明として使い、コードと
#の間に十分な空白を入れて記述します。 - 複数行のコメントは、各行の先頭に
#を付けるか、VSCode のショートカット（Ctrl+K, Ctrl+C／Ctrl+K, Ctrl+U）で効率的に作成・解除します。 - 三重クォート文字列は、場合によってはコメントアウトの代替手段として使用可能ですが、本来の用途は複数行の文字列記述です。
これらの方法を理解し、適切にコメントを活用することで、コードの可読性が向上し、保守性も高まります。自分のプログラムに説明を加え、他の人にも理解しやすいコードを書くために、ぜひVSCodeでこれらの記法を試してみてください。