【Python入門】Pythonでのコメントアウトの方法とは？

【Python入門】Pythonでのコメントアウトの方法とは？

コメントアウトをする理由とは？（その1）

Pythonに限ったことではありませんが、プログラムの要所要所でそのコードの意味やメモを残したいこともあります。 そのときに「コメントアウト」を使うと、Pythonプログラムに影響を与えることなくメモを残せますね。

■Pythonでのコメント例■

# Python3
# 円周率のプログラム

pi = 3.14 # 円周率
r = float(input("半径は何cm？"))
calc = r * r * pi
print("円の面積：" , calc , "cm2")

上記の例では、このPythonプログラムのバージョンは何か、何のプログラムか、ということが冒頭のコメントアウトで明記されています。第三者がコードを見ても、Python2かPython3かバージョンで迷うことはありませんし、何のプログラムであるか、ということも一目瞭然でわかりますね。

他には4行目の pi = 3.14 の後にもコメントが。これはこの行が何を意味するか、ということをメモすることができます。 このようにコメントアウトを使うことで自分へのメモ書きにもなりますし、第三者が見ても分かりやすいコードとなることができますね。

コメントアウトをする理由とは？（その2）

「コメントアウトした内容は、実行プログラムから無視される」という特徴を活かして、コードを試行錯誤したい時にコメントアウト機能が役立ってくれます。 例えば関数の学習において「この場合は大丈夫で、この場合はどうかな？」という時、最初に書いたコードを残しつつ、でも実行されずに違うコードで動かしたい、そんな時にコメントアウトが役立ちます。

def sample():
    a = 100
    #a = 1
    print(a)

sample()

上記の場合は、変数aの値をどうしようかな、ということで a = 1 の方をコメントアウトして無効化していますね。 あれこれ試したい時に本当にコメントアウトは便利です。

コメントアウトの方法（１行の場合）

Pythonプログラムでのコメントアウトは基本

# ●●●

です。

#の後のスペースはあってもなくても機能上は問題ありませんが、可読性の点から半角スペースを1つ空けると見やすいでしょう。 またコードの後に#を付ける場合は、コード末尾から半角スペースを1つ空けます。コードにくっつけて#を書くとコメンとかコードか困惑しますし、全角スペースにするとエラーがでます。

■コメントアウトのサンプルコード■

# Comment Sample
a = "コメント"
print(a) # 変数aを出力

コメントアウトの方法（複数行の場合）

複数行コメントアウトしたい時は、

"""
こちらは
複数行の
コメントアウト
です。
"""

と、 """ （ダブルクォーテーション）3つで囲む、もしくは ''' のシングルクォーテーション3つで囲います。

こちらのコメントアウトの方式は、「ドックストリング（docstring）」といい、主にプログラムの解説や関数の解説などが書かれます。GitHubなどのオープンソースをみているとドットストリングはよく見かけますので、書き方の作法を見ておくと自分がプロジェクトを作る時に参考になると思いますよ。

画像引用：GitHub／flask

もちろん解説以外にも、複数行のコードを無効化したい時も """ は使えますので、あれこれコードを試したいときは """ が役立ってくれます。

開発環境毎のコメントアウトの様子

参考として開発環境毎のコメントの様子を以下にご紹介します。書き方は一緒ですが、Pythonシェルスクリプトなどを使う場合は、より見やすい・分かりやすいように書く必要がありそうですね。

■Pythonシェルスクリプト■

■Jupyter■

■PyCharm（IDE）■

まとめ

自習の内は、コメント内容を気にする必要はあまりないと思いますが、プログラムを公開したり、仕事としてPythonを使う場合はコメント内容も気にする必要があります。あまり長くなってもいけませんし、かと言って意味が分からなくてはいけません。 コメントアウトの記述方法を覚えた後は、書く内容や作法を習得するために、サンプルコードを見た時はどんなことが書かれているのかな、と日頃から気に留めるとワンランク上のPythonプログラマになると思います。

コメントアウト以前に、Pyhtonファイルの作成方法、実行方法がわからないという方、オンラインレッスンのCodeCampいかがでしょうか？最短距離であなたをPythonプログラマに育ててくれると思いますよ。