Pythonのコメントアウトの書き方を解説！複数行の記述やエラーの対処法も紹介
Pythonでコードを書いていると、「この部分は何を実施しているのか」「どういう意図でこういう書き方をしているのか」など、不明点が必ず出てくるものです。また、チームで開発している場合、他のメンバーが書いたコードの意図が分からず、時間を無駄にしてしまうこともあるでしょう。
そんなときに役立つのがコメントアウトです。今回は、Pythonのコメントアウトの基本から応用テクニック、エラーが出たときの対処法まで、実践的な内容をお届けします。
Pythonのコメントアウトとは？
Pythonのコメントアウトとは「実行されない文字列」のことです。
コメントアウトされた部分は、Pythonインタープリターが実行時に完全に無視します。つまり、どれだけ長いメモを書き込んでも、プログラムの動作には一切影響を与えません。
この特性を活かして、開発者はコードの説明や備忘録、あるいは動作確認中のコード保存など、さまざまな用途にコメントを活用しています。
プログラムは書いた本人でさえ、数ヶ月後には内容を忘れてしまうもの。ましてやチーム開発では、他のメンバーが書いたコードを理解しなければならないため、欠かせない機能のひとつといえます。
コメントのさらに詳しい概要については、以下の記事で詳しく紹介していますので、ぜひ参考にしてください。
Pyhtonのコメントアウトの使用目的と役割
コメントアウトには、さまざまな活用方法があります。
まず挙げられるのが「コードの意図を記録する」という本来の役割です。複雑なアルゴリズムや特殊な処理を実装した際、なぜその方法を選んだのか、どんな仕様に基づいているのかといった背景情報を残しておくことができます。こうした情報は、後からコードを修正する際に非常に貴重な手がかりとなるでしょう。
次に挙げられるのが、「デバッグ作業での活用」です。プログラムにバグが発生した際、問題の原因を特定するため、一部のコードを一時的に動作させないようにしたいケースがありますが、コメントアウトを使えば、コードを削除せず実行を停止できるため、後で簡単に元に戻せます。
さらに「チーム開発におけるコミュニケーション手段」としての側面もあります。「この部分は将来的に改修予定」「パフォーマンス改善の余地あり」といったメモを共有することで、チーム全体の認識を揃えられます。
そして、古いコードを完全に削除せず「念のため残しておく」用途にも使われます。
Pythonのコメントアウトの使用シーン
主に以下のようなシーンが挙げられます。
- 関数やクラスの説明
- 複雑な計算式の解説
- TODO管理
- テストコードの管理
使用シーンとして、典型的なのが「関数やクラスの説明」です。この関数は何を受け取り、何を返すのか。どんな処理を行うのか。こうした情報をコメントとして記載しておくことで、APIドキュメントとしても機能します。
また「複雑な計算式の解説」も重要な使用例です。数学的な処理や特殊なアルゴリズムを実装する際、計算式だけを見ても理解が難しいケースがあります。そんなとき、式の意味や参考にした論文、使用している変数の定義などをコメントで補足すると、格段に読みやすくなります。
開発途中では「TODO管理」としても活躍します。「ここはエラーハンドリングを追加する必要がある」「パフォーマンステストが必要」といった作業メモを、実装箇所に直接書き込むといった具合です。
さらに「テストコードの管理」にも便利です。特定の機能をテストするコードを複数パターン用意し、必要に応じてコメントアウトを切り替えることで、柔軟にテストを実施できます。
ちなみにPythonでは、
- 一行だけをコメントにする方法
- 複数行をまとめてコメントにする方法
の2種類が用意されています。具体的な書き方は、次の章で解説します。
「なんか今の仕事合わないな・・・」
「IT業界に転職してみたいなぁ・・・」
という方、DMMが運営する「WEBCAMP エンジニア転職」をご検討してみてはいかがですか？
「WEBCAMP エンジニア転職」では最短12週間でITエンジニアを目指すことが可能です！
WEBCAMPの卒業生は転職後に年収もUP！（例：年収250万円→500万円）
しかも今なら受講料の最大70%が給付金として支給されます。
DMM WEBCAMPは経済産業省・厚生労働省が認定した専門実践教育訓練給付金制度の対象です
【Python】コメントアウトの書き方
Pythonでコメントを記述する方法は、主に2つあります。
- コードの1行だけにメモを残す
- 複数行にわたって説明を書き込む
ここでは、それぞれの記述方法と実際の活用場面について詳しく見ていきます。
基本の書き方
Pythonのコメント記述で使用する記号は「#」(ハッシュ記号)です。この記号を書いた位置から行末までが、実行時に無視される仕組みになっています。
# この行全体がコメントです
print("Hello") # この部分だけコメントプログラムが動作する際、Pythonインタープリターは#以降の文字列を完全にスキップするため、どれだけ長い文章を書いても処理速度に影響しません。記述位置も自由度が高く、行の最初に置けば行全体がコメントになり、コードの後ろに置けばそのコード行にメモを添えられる、といった具合です。
行単位でのコメントアウトの記述方法（インラインコメント）
インラインコメントとは、実際のコードと同じ行にコメントを配置する書き方です。主に変数の説明や処理の簡単な補足を、その場で付け加えたいときに活用します。
price = 1000 # 商品の価格
tax_rate = 0.1 # 消費税率
total = price * (1 + tax_rate) # 税込み価格を計算書き方のポイントは、コードと#記号の間に最低2つのスペースを入れることです。また、#記号の直後にも1つスペースを空けるのが推奨されています。
複数行のコメントアウトの記述方法（ブロックコメント）
長い説明や詳しい処理内容を記載する際は、複数行にわたるコメントが便利です。方法は以下のように、コメントにしたい各行の先頭に#記号を配置するだけです。
# この関数は顧客データを処理します
# 引数として顧客IDを受け取り
# データベースから情報を取得して返します
def get_customer_data(customer_id):
# 処理内容
passこれは関数の動作説明や複雑なアルゴリズムの解説など、詳細な情報を残したい場面で重宝します。なお、トリプルクォート(“””または”’)を使う方法もありますが、これは厳密にはコメントではなく文字列として扱われるため、通常は#記号を使った方が確実でしょう。
Pythonのコメントの書き方については、以下の記事でも詳しく解説しています。興味のある方はぜひご一読ください。
Pythonでコメントアウトを書く際に便利なショートカットキー
コメントアウトはとくに複数行の場合、手入力するのは、非常に面倒です。そこで活用したいのが、各エディタに備わっているショートカットキーです。
ここでは、コメントアウトのショートカットキーをエディタ別に紹介します。
①Visual Studio Code（VS Code）
VS Codeでは、選択行に以下を入力するだけでコメント化できます。
- Windowsやリナックス：「Ctrl + /」
- Mac：「Cmd + /」
複数行を一度にコメントアウト（ブロックコメント）したい場合は、以下のとおりです。
- Windowsやリナックス：「Shift + Alt + A」
- Mac：「Shift + Cmd + A」
ちなみに以下では、Visual Studio Codeについて解説しているので、興味のある方はぜひご一読ください。
②PyCharm
PyCharmの場合は、選択行に以下を入力すればコメント化が完了します。
- Windowsやリナックス：「Ctrl + /」
- Mac：「Cmd + /」
そして、複数行を一度にコメントアウトしたい場合は、次のショートカットが使えます。
- Windowsやリナックス：「Ctrl + Shift + /」
- Mac：「Cmd + Shift + /」
③Sublime Text
Sublime Textの場合もほぼ同様で、選択行に以下を入力すればコメント化できます。
- Windowsやリナックス：「Ctrl + /」
- Mac：「Cmd + /」
また複数行を一度にコメントアウト（ブロックコメント）したい場合は、以下のショートカットを使います。
- Windowsやリナックス：「Ctrl + Shift + /」
- Mac：「Cmd + Shift + /」
④Jupyter Notebook
Jupyter Notebookの場合も、選択行に以下を入力すればコメント化が完了します。
- Windowsやリナックス：「Ctrl + /」
- Mac：「Cmd + /」
Jupyter Notebookには、ブロックコメント専用のショートカットは用意されていません。そのため、複数行を一度にコメントアウトする場合、対象となる行をすべて選択してから上記のショートカットを使用します。
Pythonでコメントアウトできない原因と対処法
コメントの書き方には実は細かなルールがあり、ちょっとした記述ミスでプログラムが正常に動かなくなることがあります。ここでは、よくあるエラーパターンと解決方法を紹介します。
使用する記号が間違っている
他のプログラミング言語を経験していると、ついつい別の言語の記法を使ってしまいがちです。たとえば、JavaやJavaScriptでは「//」や「/* /」でコメントを書きますが、Pythonではこれらの記号は構文エラーになってしまいます。
Pythonで認識されるのは「#」記号だけなので、注意しましょう。なお、以下ではHTMLのコメントアウトの記述法を紹介しているので、興味のある方は参考としてご覧ください。
インデントが不揃いである
Pythonはインデント（字下げ）に厳格な言語です。コメントを書く際も、周囲のコードとインデントを揃える必要があります。
特にトリプルクォートを使った複数行コメントでは、インデントのズレがエラーの原因になりやすいので注意が必要です。関数やクラスの中にコメントを書く場合、その定義と同じレベルにインデントを合わせましょう。
対処法としては、エディタのインデント表示機能を活用しつつ、コード全体の字下げが統一されているか確認することです。
記号に抜け漏れがある
トリプルクォートを使ってコメントを書いたとき、開始の「”””」は入力したのに、終わりの「”””」を書き忘れてしまうケースです。この状態では、コメントの終わりが認識されず、その後のコードがすべてコメント扱いになってしまいます。
対処法としては、トリプルクォートを入力する際、開始と終了を必ずセットで書く習慣をつけることです。また、エディタの自動補完機能を活用すれば、コメントの閉じ忘れを防げるでしょう。
全角の#を使用している
こちらも非常によくあるミスで、日本語入力モードのまま「#」を打ってしまうと、全角の「#」が入力されてしまいます。見た目が似ているので気付きにくいですが、全角の「#」はコメント記号として認識されないので、エラーとなってしまうのです。
対処法はエディタのショートカットを使うこと、またエラーが出でしまった場合、真っ先に全角を疑うことが挙げられます。
トリプルクォート（”””）を入れ子にしている
トリプルクォートで囲んだコメントの中に、さらにトリプルクォートを入れてしまうと、Pythonは最初の終了記号でコメントが終わったと判断してしまいます。その結果、構文エラーが発生します。
とくに、長いコメントを書いているときや、複数の説明を追加しようとしたときに起こりやすいミスです。対処法は、コメントを入れ子にせず、#記号を使った行コメントに書き換えることです。
Pythonのコメントアウトに関する注意点・コツ
コメントアウトを効果的に活用するには、いくつかのポイントを押さえる必要があります。ここでは、コメントを書く際に気を付けたい点と、より読みやすいコードにするためのテクニックを紹介します。
コードを読めばわかるコメントは書かない
不要なコメントは書かないようにしましょう。見ればわかる内容をコメントアウトしても、かえってコードが読みづらくなるだけだからです。
コメントで書くべきは「何をしているか」ではなく「なぜそうしているか」です。処理の背景や理由、設計上の意図を残すことで、後から見た人が迷わずに済みます。
本当に必要な情報だけを厳選して記載しましょう。
コメントは短く簡潔に記載する
コメントは短いに越したことはありません。長々とした説明文を書いても、読む側の負担が増えるだけです。
コメントは要点を絞り、できるだけ短い文章で伝えるよう心がけましょう。複雑な数式や詳細なアルゴリズムの解説をコメントに詰め込むのではなく、大まかな処理内容が分かる程度の記述で十分です。
もし詳しい説明が必要なら、別途ドキュメントを用意する方が適切なこともあります。
#記号は範囲を指定できない
他のプログラミング言語では、特定の範囲だけをコメントにする記法がありますが、Pythonの#記号にはそうした機能がありません。#を書いた位置から行末までがコメントになる仕組みです。
つまり、行の途中の一部分だけを選んでコメント化することはできないわけです。たとえ#記号を複数回使っても、最初の#以降はすべてコメント扱いになります。
この特性を理解していないと、意図しない動作を引き起こす原因になるので注意しましょう。
トリプルクォートは「コメント」ではなく「文字列」である
トリプルクォート(“””や”’)で囲まれた部分は、一見コメントのように見えますが、実際には文字列データとして扱われています。プログラム実行時に無視されるわけではなく、メモリ上に保持されてしまうため、本来のコメントとして使うには適していません。
トリプルクォートは関数やクラスの説明文(docstring)として使うのが正しい用途です。通常のコメントが必要な場面では、素直に#記号を使いましょう。
即戦力が身につくプログラミング学習のDMM WEBCAMP
Pythonをはじめとするプログラミングスキルを本格的に学ぶなら、DMM WEBCAMPがおすすめです。DMM WEBCAMPでは、以下の3つのコースから、自分の生活や状況に合わせて選ぶことができます。
いずれのコースも経済産業省や厚生労働省の認可を受けたリスキリング制度を設けており、最大64万円の補助金が適用可能です。完全初心者向けの転職サポートもついているため、確実なキャリアチェンジを実現したい方におすすめの内容です。
まとめ
Pythonのコメントアウトは、コードの可読性を高め、チーム開発を円滑に進めるための重要な機能です。今回は、基本的な書き方から、インラインコメントやブロックコメントといった使い分け、さらにはエディタのショートカットキーなどを解説してきました。
適切なコメントは自分だけでなく、他の開発者にとっても貴重です。今回紹介した内容を参考に、読みやすく保守しやすいコードを書いていきましょう。
コメントアウトの基礎文法を理解したら、次は実務で通用するプログラミングスキルの習得を目指すのがいいでしょう。DMM WEBCAMPでは、未経験からプロのエンジニアを目指せる3つのコースを用意しています。
現役エンジニアのマンツーマンサポートで、実践的なスキルが着実に身につくだけでなく、すべてのコースが経済産業省や厚生労働省認定のリスキリング制度対象となっており、最大64万円の補助金が活用できます。
本気でエンジニア転職を目指す方は、ぜひ検討してみてください。
