プログラミングをしていると、コードを他人や未来の自分に説明するためにコメントを使うことは不可欠です。コメントとは、プログラムのソースコード内に記述するが、プログラムの実行には影響を与えないテキストのことです。この記事では、Pythonにおけるコメントアウトの方法４選を紹介します。
1行コメントアウト（基本のやり方）
Pythonで最も一般的なコメントアウトの方法は、ハッシュ記号（#）を使用する方法です。この記号を行の先頭につけることで、その行をコメントとして扱うことができます。
# これはコメントです
print("Hello, World!") # 行末にコメントを加えることも可能出力結果
Hello, World!このように、出力の際にはコメントアウトとして実行されません。
１行コメントは、その行で何をしているのかを説明する際に便利ですが、過度に使用するとコードが読みにくくなるため、簡潔に書くことが重要です。
複数行のコメントアウト
複数行にわたるコメントを一度にコメントアウトしたいときは、いくつかの方法があります。
複数の#を使用する方法
各行の先頭にハッシュ（#）記号をつけることで、複数行をコメントアウトすることが可能です。
# これは複数行にわたる
# コメントです
# １行ずつハッシュ記号を使う
print("Hello, World!")出力結果
Hello, World![補足]複数行をまとめて＃を入力する方法
各行の先頭にハッシュ（#）記号をつけることでコメントアウトできることが分かったけど、複数行を毎回キーボードで操作するのが面倒だな💦
※使用ツール
Jupyter Notebook
以下、使用手順と動画を添付しています。
複数行に毎回記号を記述するのは大変なので、「Ctrl」キー（Macだと「optionキー」）を活用して、楽にコメントを入力していきましょう。
使用手順
①ある行の先頭をクリック
②「Ctrl」+ 「各行の先頭」をクリック
③「Ctrl」を押しながらハッシュ記号を入力
三重引用符を使用する方法
三重引用符（”’や”””）を使うことで、ブロック全体をコメントアウトすることもできます。この方法は、特に一時的に大きなコードブロックを無効化したい場合に便利です。
'''
複数行の
コメントになります。
簡単にコメントアウトできます。
'''
print("Hello, World!")"""
こちらも同様に
三重の二重引用符で
複数行をコメントアウトできます。
"""
print("Hello, World!")出力結果
Hello, World!”’：シングルクォーテーション
“””:タブルクォーテーション
上記のように、シングルもしくはダブルクォーテーションを３つつなげて記述することで、ブロック単位でコメントアウトが可能になります。
ドキュメンテーションコメント
関数やクラスに対する説明として使われるドキュメンテーション文字列（docstring）も、一種のコメントとして活用されます。コードの意図や使用方法を他の開発者にも伝えることができます。
def greet(name):
"""
この関数は、指定された名前に対して挨拶を返します。
:param name: 挨拶する名前
:return: 挨拶メッセージ
"""
return f"こんにちは、{name}さん！"
greet("Jun")出力結果
こんにちは、Junさん！このようにクラスや関数を定義する際、引数や返り値の説明などをコメントしておくことで、他の開発者に対して関数のドキュメントとして詳細に伝えることができます。
ここまでPythonにおけるコメントアウト４選を紹介してきました。コメントを効果的に使うことで、プログラムの理解が容易になり、後で見返したり、他の人がコードを読む際に非常に役立ちます。しかし、過剰なコメントは逆に混乱を招くこともあるため、適度に使用することを心がけましょう。
コメント