Python♪用語集:コメントアウト

0.Python♪ モヤモヤを解消する明快な用語集

「Python♪モヤモヤを解消する明快な用語集」の用語集Top(索引)はこちらです。

モヤモヤを解消する明快な用語集を目指します。例えば言葉の定義が「グレー」なものは「グレー」であると解説します。なお、同じ言葉でも、例えば「Python」と「Java」では定義が違うことがあります。 その場合、「python」での定義を解説します。

1.解説する用語

「コメントアウト」

2.コメントアウト

Pythonでは、コードの中に半角の「#」(ハッシュタグ)を使用すると、「#」を記述した行の「#」以降のコードを無効にできます。例えば行の最初を「#」にすると、その行のコードはすべて無効になります。このように、「#」のような特定の記号を用いて、コードの一部を無効にすることを「コメントアウト」といいます。コメントを書くことがコメントアウトではありません。

(1) コメントアウトの役割

コメントアウトは、主に以下のような場合に使われます。

(1)コードを説明するコメントを挿入する。
(2)バグを見つける作業(デバッグ)で、一時的に一部のコードを無効にする。

(2) 実は「'''」はコメントアウトではない

複数行のコメントを記述する場合、無視したいコードの前後に「'''」(3つの半角シングルクォーテーション)や、「"""」(3つの半角ダブルクォーテーション)を記述する方法が使われますが、実はこれはコメントアウトではありません。

Pythonでは、 コード01の4行目のように文字列を単独で記述することができるので、複数行の文字列を表現できる 「'''」 「"""」 をコメントアウトのように使っているだけです。

ですから、文字列の最初のインデント幅を自由にすることはできません。例えばコード01の9行目のインデント幅は、自由に設定できる訳ではありません。12行目のprint(i)とそろえる必要があります。

また、文字列ですから「'''aaa\bbb'''」のように特殊文字の「\」をエスケープせずに単独で使用することはできません。

一方、「#」を用いたコメントアウトの場合、インデント幅は自由ですし、文字列ではないので、#の後には何を記述してもエラーにはなりません。例えば「#aaa\bbb」のように「\」を単独で使用としてもエラーになりません。

以下、コード01は問題なく、実行されます。もちろん、美しいコードではありません。

#コード01
#「#」のあとには、特殊文字「'」「\」でも記述できる。エスケープする必要はない。
   #インデント幅も自由です。
'Pythonでは文字列を単独で記述することができる。'
'''つまり、複数行の文字列も
単独で記述することができる。
でも、これは正確にはコメントアウトではない。'''
for i in range(10):
    '''文字列なので、最初の行のインデント幅は
      print(i)とそろえる必要がある。
  でも、最初だけそろえれば、2行目以降はそろえなくてもよい。'''
    print(i)

[a0050]

3.参考記事

上記の内容がわかりにくい場合は、以下の記事を参考にしてください。詳しい解説をしています。

基本:コメントアウトと、インデントやエスケープシーケンス

私が実際に購入した教材のご紹介

以下、私が実際に購入したPythonの教材をまとめてみました。 Pythonを学習する上で、少しでもお役に立つことができればうれしいです。

Python♪私が購入したPythonの書籍のレビュー

UdemyのPythonの動画講座を書籍を買う感覚で購入してみた