【初心者向け】Pythonでコメントアウトする方法を解説【複数行・一行ずつ】

プログラミングをしていると、「コメントアウト」をすることがよくあります。

コメントアウトとは、簡単に言うとコードの一部を無効化したりコードに関する説明をメモとして残すことができる機能です。

プログラミングの勉強をし始めたばかりの方の中には、コメントと言われて「どのような場合に使うのかわからない」「コメントを残す余裕がない」と感じる方もいるかもしれません。

しかしコメントアウトを使うと、実行はしたくないけど残しておきたいコードや、メソッドやクラスに関する説明などをコード内に保持できて非常に便利なのです。またコメントはプログラミングの勉強だけでなくチーム開発でも役立つため、エンジニアの実務でも活用されています。

この記事では、プログラミング初心者の方向けにPythonでコメントアウトをする方法について解説します。

Pythonの勉強を始めたばかりの方や、コメントアウトについてよくわからないプログラミング初心者の方はぜひ参考にしてください。

【目次】

コメントアウトとは
コメントアウトを使うメリット
Pythonでコメントアウトをする方法
- 一行のコメントアウトをする方法
- 複数行まとめてコメントアウトする方法
コメントアウトをする際の注意点
Pythonのコメントアウトを学んでみよう

コメントアウトとは

前述の通りコメントアウトとは、コードの一部分や説明の文字列を無効化する機能です。

たとえばコードの一部分をコメントアウトしておくと、実行時にその部分は実行されずに飛ばされます。

コメントアウトをする方法についてはあとでまた説明しますが、以下のコードで「Hello World!を表示する」という文字列はコメントとなっているため実行されることはありません。Pythonのコードには、このような形式でメソッドの説明文などをコードに影響しないコメントとして残すことができるのです。

# Hello World!を表示する
print('Hello World!')

「コードが長くなるしコメントを書く時間が余分にかかってしまうのに、なぜコメントを残す必要があるの？」「実行に必要なコードだけがあればよいのでは？」と思うかもしれませんが、コメントアウトを使うとさまざまなメリットがあります。

コメントアウトを使うメリット

たしかにコメントを残そうとするとコード全体が長くなりますし、コードだけでなくコメントを書く時間が余分にかかってしまいます。しかしコメントを残しておけば、さまざまなメリットが受けられるのです。

ここからは、コメントアウトを使うメリットについて解説します。コメントアウトを使う意味がいまいちよくわからない、今までコメントアウトを使ったことがないという方はぜひ参考にしてください。

以前のコードを残したまま書き換えたり、書き換えたコードをもとに戻したりできる

たとえばwhile文の練習をしているときに「同じ処理をfor文で書いたらどうなるんだろう」と思ったり、カウントダウンを表示させる問題を解いているときに「カウントアップをさせるにはどうしたらいいんだろう」と思ったりしたことはありませんか。

プログラミングの勉強をしていると、「こんな書き方をしたらどうなるのかな？」と思うことがよくあるはずです。

そんなときはコメントアウトの出番です。該当する部分を一旦コメントアウトして新たなコードを書けば、既存のコードを保持したまま試したいコードを実行できます。

ここで既存のコードを毎回削除していると、「やはり前に書いていたコードが正しそうだから戻したい」となったときに戻すのが非常に大変です。長いコードや複雑な処理をしている部分だった場合は、もともとどう書いていたのかがわからなくなってしまうかもしれません。

しかしコメントアウトを使えば、一旦既存のコードをコメントにするだけで簡単にさまざまなコードを試すことができるのです。

機能や処理などに関する説明やメモ書きができる

コードだけでなく日本語でのメモ書きもコメントアウトできるため、実装した処理の中に説明文を残すことができます。

「そんなのコードを見たらわかるのでは？」と思うかもしれませんが、長いコードや複雑な処理、似ているけど少しずつ異なるメソッドが複数ある場合など、毎回すべてのコードを読み解くのは非常に大変です。

しかしコメントで説明を残しておけば、どのようなクラスなのか、なにをするためのメソッドなのかが一目でわかります。

またコードの内部にも行ごとに「ユーザーIDを取得する」「◯◯の数値を返す」などといったコメントを残しておけば、どこでなにをしているのかがわかりやすくなります。

もちろんすべてのコードや簡単な処理にまで逐一コメントをする必要はありませんが、複雑な部分だけでも説明を残しておけば、あとから見返したり修正したりする際に役立つでしょう。

チーム開発で必要となる情報を残しておくことができる

プログラミングの勉強は独学でしている方が多いかと思いますが、エンジニアの実務ではチームで開発をすることがほとんどです。

複数人で開発をする際も、コメントは重要な役割を果たします。コメントを使えば、たとえば既存のコードを修正したときに「誰がいつ、なんのためにどのような修正をしたのか」といった情報をコード内に残しておくことができます。

複数人で一つのプロダクトやサービスを開発していると、このようなコメントがなければ「なぜこのようなコードになっているのか」「以前とコードが違うけどいつどのような目的で変更されたのか」といったことがわからなくなってしまいます。

そのため、プログラミングの勉強だけでなくエンジニアになってからの実務でもコメントを残すことが重要なのです。

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

コメントアウトを活用すると、前述のようなメリットが受けられます。

ここからは、実際にPythonのコード内でコメントアウトをする方法について解説します。

Pythonでは一行のみコメントアウトをする方法と、複数行まとめてコメントアウトをする方法があります。

一行のコメントアウトをする方法

まずは一行のみをコメントアウトする方法について解説します。

Pythonでは、行の先頭に # をつけるとその行全体がコメントとなります。

以下のコードで、「Hello World!を表示する」はコメントとなっています。

# Hello World!を表示する
print('Hello World!')

また # を使えば行の途中からでもコメントアウトできるため、改行をせずコードの直後にコメントをつけることも可能です。

以下のコードで、「Hello World!を表示する」はコメントとなっています。

print('Hello World!') # Hello World!を表示する

なおpaizaラーニングの新・Python入門編2: 標準出力を学習しようでは、Pythonで一行ごとにコメントアウトをする方法を詳しく解説しています。

➜レッスンの詳細を見る

複数行まとめてコメントアウトする方法

次に複数行をまとめてコメントアウトする方法について解説します。

Pythonでは、複数行を ''' （3つのシングルクォート）もしくは """（3つのダブルクォート）で囲むと一括でコメントアウトすることができます。

これを使うと、以下のように変数やメソッド、クラスなどに関する説明を複数行にわたって残すことができます。

'''
user_ID：ユーザーID
user_No：ユーザー番号
user_name：ユーザー名
'''

"""
カートにある商品の金額を加算するメソッド
return：合計金額
"""

なおpaizaラーニングのPython入門編1: プログラミングを学ぶでは、Pythonで複数行のコメントアウトをする方法について詳しく解説しています。コメントアウトについてもっと知りたい方はぜひごらんください。

➜レッスンの詳細を見る

コメントアウトをする際の注意点

コメントアウトは非常に便利な機能ですが、使用をするにあたっていくつかの注意点があります。

プログラミングの勉強を始めたばかりの方や、エンジニアを目指している方はぜひ参考にしてください。

行の途中から途中までをコメントアウトすることはできない

前述の通り # を使えば行の途中からコメントアウトができますが、行の途中から途中までをコメントアウトすることはできません。

たとえば以下のようなコードを書いても「Hello World! と出力」だけをコメントアウトすることはできません。この場合最初の # 以降はコメントの扱いとなるため、実行するとエラーとなってしまいます。

print(# Hello World! と出力 # 'Hello World!')

インデントがずれているとエラーになる

Pythonでトリプルクォートを使って複数行をコメントアウトする場合は、下記のように行のインデントを必ず揃えるようにしましょう。

i = 1
while i < 3:
    print(f"{i} 回目")

    j = 1
    while j < 3:
        print(f"{i}-{j}")
        j += 1
       """
       whileを使った二重ループ
       このコメントはインデントが揃っている
       """
    i += 1

下記のようにインデントがずれたコメントがあると、実行をした際にエラーの原因となってしまうため注意してください。

i = 1
while i < 3:
    print(f"{i} 回目")

    j = 1
    while j < 3:
        print(f"{i}-{j}")
        j += 1
"""
whileを使った二重ループ
このコメントはインデントがずれている
"""
    i += 1