Python入門　コメントでプログラムの命令文を無効化する

コメントとは、プログラム（ソースコード）に記述した説明文や命令文のことです。プログラム（ソースコード）に説明文や命令文をコメントとして記述し実行時に無効化する方法を解説します。

コメント「#」でプログラムの命令文を無効化できる

Pythonのコメントは半角記号「#」で表します。「#」から行の終わり「改行」までがコメントとなりプログラム（ソースコード）を実行してもコメント部分（解説文や命令文）は無視されます。

つまり「#」の後には全角文字の日本語による解説文やPythonの半角英数記号などによる命令文など何でも記述可能です。

Pythonプログラミングでコメントの使い道は２つ

Pythonプログラミングにおいてコメントは最も重要な機能の１つです。Pythonのプログラム（ソースコード）でコメントを使用するケースは２つあります。

1. プログラム（ソースコード）の内容を説明する
2. プログラム（ソースコード）の一部を無効化する

プログラム（ソースコード）の内容を説明する

コメントでプログラムの目的や機能、処理の内容、注意点などの説明文を記述しておくと後からプログラムを読む人の助けになります。

自分が作成したプログラムであっても時間が経つと忘れてしまうものです。自分も含め次にプログラムを読む人が内容をしっかり理解できるコメントが理想です。なおプログラムを変更したらコメントの更新も忘れずに行いましょう。

プログラム（ソースコード）の一部を無効化する

プログラムが完成した時点では完璧であっても時間の経過によってOSのバージョンアップやPythonのバージョンアップなど環境の変化でエラーが発生することがあります。

プログラムでエラーが出ている命令文を実行したくない場合や動作確認で一時的に実行したくない命令文をコメント化（コメントアウト）します。

Pythonのコメントの書き方：インラインコメント

命令文の後に記述するコメントをインラインコメントと呼びます。「＃」の右側には半角スペースを１つ入れます。左側には半角スペースを２つ入れます。ただし、コメントの開始位置を合わせる場合は半角スペースを２つ以上入れてもかまいません。

プログラム（ソースコード）

赤線部分がインラインコメントです。

行番号２はプログラム（ソースコード）を読みやすくするため行番号１に合わせてコメントの開始位置を揃えています。

print("Hello everyone!")  # インラインコメント
print("Python-Start")     # インラインコメント

プログラム（ソースコード）の保存先

コマンドプロンプトでPythonのプログラム（ソースコード）を実行

実行結果を見るとインラインコメントより前の部分のみ実行されています。

Pythonのコメントの書き方：ブロックコメント

行頭から記述するコメントをブロックコメントと呼びます。「＃」の右側には半角スペースを１つ入れます。左側には半角スペースを入れません。ただし、コメントの開始位置を合わせる場合は字下げ（インデント）した分の半角スペースを入れてもかまいません。

プログラム（ソースコード）

赤線部分がブロックコメントです。

１行の場合も複数行の場合も同じように行頭に「#」を記述すればブロックコメントにできます。段落内に空白行を含む場合（行番号４と８）も同様です。

# 1行のブロックコメント

# 複数行のブロックコメント（ここから）
# 
# 下記２行はブロックコメントでコメントアウト（無効化）したソースコード
# print("Hello everyone!")
# print("Python-Start")
# 
# 複数行のブロックコメント（ここまで）

# 下記はコメントアウトしていない有効なソースコード
print("ありがとうございます！")

プログラム（ソースコード）の保存先

コマンドプロンプトでPythonのプログラム（ソースコード）を実行

実行結果を見るとブロックコメントでコメントアウトした部分は実行されず有効な部分のみ実行されています。

まとめ

Pythonプログラミングにおいてコメントの使い道は２つあります。プログラムの内容説明とプログラムの一部無効化です。

コメントは半角記号「#」で表し「#」から行の終わり「改行」までがコメントとなります。

コメントには２種類の書き方があります。命令文の後に記述するインラインコメントと行頭から記述するブロックコメントです。

プログラム（ソースコード）をコメント化（コメントアウト）した部分は実行時に無視されます。