Python でコードのブロックにコメントする

Muhammad Maisam Abbas 2023年1月30日
  1. Python で複数行をコメントアウトするには、各行の前に # を追加する
  2. Python の複数行コメントに三重引用符を使用する
  3. Python の複数行コメントには if False:を使用する
  4. Python の複数行コメントに文字列変数を使用する
  5. Python の複数行コメントにコードエディタを使用する
Python でコードのブロックにコメントする

このチュートリアルでは、Python で複数行のコードをコメントアウトする方法について説明します。

Python で複数行をコメントアウトするには、各行の前に # を追加する

# は、Python の 1 行コメントに使用されます。残念ながら、Python で複数行のコードをコメントアウトするデフォルトの方法はありません。# を使用して複数のコード行をコメントアウトするには、各行の前に # を追加する必要があります。次のコード例は、# を使用して Python で複数のコード行をコメント化する方法を示しています。

# Hello! this is a
# Multiple line comment
# print("This is a comment")
print("This is not a comment")

出力:

This is not a comment

上記のコードでは、コードの最初の 3 行を、各行の前に # を使用してコメントアウトしています。このアプローチは、行数が少なくても問題ありませんが、行数が非常に多い場合、このプロセスは非常に手間がかかる可能性があります。

Python の複数行コメントに三重引用符を使用する

トリプルクォートはコードのドキュメント化に使用され、コードの実行中には実行されません。次のコード例は、三重引用符を使用して Python で複数のコード行をコメントアウトする方法を示しています。

"""
Hello! this is a 
Multiple line comment
print("This is a comment")
"""
print("This is not a comment")

出力:

This is not a comment

上記のコードでは、コードの最初の 3 行を三重引用符で囲んでコメントアウトしています。三重引用符は、労力を大幅に削減します。ただし、三重引用符はコードのドキュメント化に使用するように設計されており、コードのコメントアウトには使用しないでください。

Python の複数行コメントには if False:を使用する

Python で複数行のコードをコメントアウトするために使用できる別のアプローチは、if False:ステートメントです。このコードブロックで記述されたものはすべて、このコンテキストでは False ではないため、実行されることはありません。コメントしたいコードのブロックの前に if False:を記述してから、if ステートメント内でコードをインデントする必要があります。次のコード例は、if False:を使用して Python で複数のコード行をコメントアウトする方法を示しています。

if False:
    print("This is a comment")
    print("This is another comment")
print("This is not a comment")

出力:

This is not a comment

上記のコードでは、if False:を使用して 2 行のコードをコメントアウトしました。このアプローチの唯一の問題は、適切な構文のコードブロックしかコメントアウトできないことです。インタプリタは、このコードブロックで構文エラーを検出します。

Python の複数行コメントに文字列変数を使用する

文字列変数を使用して、複数行のコードを格納できます。三重引用符を使用して、文字列変数に複数行のコードを格納できます。次のコード例は、文字列変数を使用して Python で複数のコード行をコメントアウトする方法を示しています。

comments = "This is a variable for commenting"
comments = """Hello! this is a 
Multiple line comment
print("This is a comment")"""
print("This is not a comment")

出力:

This is not a comment

同じ変数を複数回使用して、Python のコードの複数のブロックにコメントを付けることができます。

Python の複数行コメントにコードエディタを使用する

Python で複数行のコードをコメントアウトするために使用できる多くのアプローチについて説明してきました。しかし、残念ながら、上記のアプローチはどれも最適な解決策ではありません。このタスクの最善の解決策は、目的のコードエディターのキーボードショートカットを使用して、Python で複数行のコードをコメントアウトすることです。

VisualStudio コード

Visual Studio Code で、コードのブロックを選択し、Ctrl + kCtrl + cを使用してコメントし、 Ctrl + kCtrl + uでコメントを解除します。

Notepad++

Notepad++ で、コードのブロックを選択し、Ctrl + kを使用してコメントします。

PyCharm

Pycharm IDE で、コードのブロックを選択し、Ctrl + /を使用してコメントとコメント解除を行います。

使用しているコードエディタに関係なく、複数行のコードをコメントアウトする方法があります。複数の行をコメントアウトするためのキーボードショートカットを検索することです。

Muhammad Maisam Abbas avatar Muhammad Maisam Abbas avatar

Maisam is a highly skilled and motivated Data Scientist. He has over 4 years of experience with Python programming language. He loves solving complex problems and sharing his results on the internet.

LinkedIn

関連記事 - Python Syntax