.net column
.NET開発者のためのブログメディア

Pythonで複数行をコメントアウトする方法|サンプルコードで分かりやすく解説!

公開日時:   更新日時:
Pythonで複数行をコメントアウトする方法|サンプルコードで分かりやすく解説!
基本情報技術者試験の試験対策はこちら>>
SE
Pythonで複数行にコメントを付ける方法について教えていただけますか。
PM
複数行にコメントを付けるのはプログラムのテストやソースコードの注釈を書く際に必要となります。それでは、複数行にコメントを付ける方法についてご紹介しましょう。

コメントアウトについて


プログラム内のソースコードを特殊な記号で囲み、処理が実行されないように無効化することを「コメントアウト」と言います。コメントアウトされたソースコードは、「コメント」になります。

コメントアウトは、プログラムをテストする場合や注釈を書き込む際に使用します。

Pythonで一行コメントアウトする場合は「#(シャープ)」を使いますが、複数行をコメントアウトする場合はどう記述するのでしょうか。

この記事では、Pythonのコードを複数行コメントアウトする方法についてご紹介しますので、興味のある方はぜひご覧ください。

Pythonで複数行をコメントアウトする方法


Pythonではソースコードの先頭に「#(シャープ)」をつけることで、1行分コメントアウトすることができます。しかし複数行をコメントする場合、全ての行に「#(シャープ)」を1つ1つ入力することは効率的ではありません。

そこでPythonでは、プログラムや関数などの説明をするドキュメンテーション文字列 (documentation string、またはdocstring)を記入する方法によってコメントアウトを行います。

具体的には、対象のソースコードをトリプルクォート(三重引用符)、すなわち「”””(ダブルクォーテーション3つ)」または「”’(シングルクォーテーション3つ)」で囲むことでコメントアウトすることができます。

それでは、実際のコードを確認してみましょう。(実行環境:Jupyter Notebook 6.2.0、以降同じ環境で実行)

実行結果は以下の通りになります。コメントアウトした箇所は無視され、コメントアウト部分の上下にあるソースコードだけが実行されました。

コメントアウトに関する注意点


ここでは複数行のコメントアウトや、コメントアウトに使うトリプルクォート(三重引用符)についての注意点を紹介します。

インデントに注意

Pythonの複数行コメントは便利ですが、インデント(段落の位置)がずれているとエラーが発生します。

実際のコードで、エラーについて確認しましょう。

実行結果は、以下の通りになります。

エラーが「”””(ダブルクォーテーション3つ)」の部分で発生しています。

「IndentationError」とは、インデントの位置が間違っている場合に発生する構文エラーです。また「expected an indented block」とは日本語に訳すと「予定されるインデント」という意味であり、全体を通すと「予定されるインデントの位置が正しくない」という意味になります。

それでは、「”””(ダブルクォーテーション3つ)」を正しいインデント位置に直してみます。

実行結果は、次のようになります。

エラーが発生せず、プログラムが実行されました。

複数行をコメントアウトする際は、インデントに気をつけて行いましょう。

インライン(行内)では使用不可

複数行のコメントアウトに使用するトリプルクォート(三重引用符)ですが、この方法をインライン(行内)で実行した場合文法エラーになるので注意が必要です。

実際のコードで確認してみましょう。

実行結果は次のようになります。

SyntaxError(文法エラー)が発生してしまいました。トリプルクォート(三重引用符)は、インライン(行内)で使用しないようにしましょう。

複数行コメントアウトのショートカット


Pythonで複数行をコメントアウトする場合に、ショートカットを使用する方法があります。ショートカットを使うことで、直接入力の手間を省くことができます。

Visual Studio Codeのショートカット

Visual Studio Codeの場合、コメントアウトする箇所を選択し、
[Shift]+[Alt]+[A]キー(Windows/Linux)または
[Ctrl]+[/]キー(Windows/Linux)
の操作をすることでコメントアウトが可能です。

それでは、それぞれのコメントアウトの違いについて確認します。

[Shift]+[Alt]+[A]キーで複数行コメントアウトした場合のコードを見てみましょう。

コード全体を選択し、[Shift]+[Alt]+[A]キーを入力しました。この場合は、選択した箇所が「'''(シングルクォーテーション3つ)」で囲まれているのがわかります。

次に、[Ctrl]+[/]キーで複数行コメントアウトした場合のコードを見てみましょう。

コード全体を選択し、[Ctrl]+[/]キーを入力しました。この場合は、選択した行の先頭それぞれに「#(シャープ)」が付いているのがわかります。

それぞれのショートカットを、コメントアウトする場合の状況に応じて使い分けてみてください。

Jupyter Notebookのショートカット

Jupyter Notebookの場合、「Ctrl」+「/」キーで複数行をコメントアウトできます。

全ての行を選択した後、「Ctrl」+「/」キーでコメントアウトしたコードを見てみましょう。

Jupyter Notebookの場合、「#(シャープ)」のみを使用するショートカットが行えます。また、トリプルクォート(三重引用符)を使用するショートカットはありません。

PyCharmのショートカット

PyCharmの場合、「Shift」+「/」キーで複数行をコメントアウトできます。

全ての行を選択した後、「Shift」+「/」キーでコメントアウトしたコードを見てみましょう。

処理の書かれているコードだけでなく、空行もコメントアウトされる点が特徴的です。

PyCharmではコメントアウトする箇所を選択し、メインメニュー→Code→「Comment with Line Comment(行コメント)」を選択することでコメントアウトすることもできます。

また、メインメニュー→Code内には「Comment with block Comment(ブロックコメント付きのコメント)」という機能があります。しかし使用するプログラミング言語でPythonを選択している場合、この機能は使えません。

メモ帳ではショートカット不可

残念ながら、Windowsの標準テキストエディタであるメモ帳では複数行をコメントアウトできません。

メモ帳でPythonを複数行コメントアウトする場合には、直接トリプルクォート(三重引用符)や「#(シャープ)」を入力する必要があります。

SE
コメントアウトするにはインデントやインラインに注意が必要ですね。
PM
その通りです。また、手間を省くためにもショートカットを覚えておくといいですよ。

まとめ


この記事では、
・Pythonで複数行をコメントアウトする方法
・コメントアウトの注意点
・Pythonで複数行をコメントアウトする時に使えるショートカットキー
を紹介しました。

プログラムをテストしたい時やコードの説明を書きたいという時に、複数行をコメントアウトする方法が役に立ちます。

ぜひ、今回学んだ複数行のコメントアウト方法をシステム開発に役立ててください。


.NET分野でのキャリアアップをお考えの方は、現在募集中の求人情報をご覧ください。

また、直接のエントリーも受け付けております。

エントリー(応募フォーム)

Search

Popular

reccomended

Categories

Tags