【Python】ソースコードにコメントをつける方法（コメント化）

Pythonでプログラミングしている中で最近まできちんとわかってなかったことの１つにコメント化、コメントをつけるということがありました。

コメント化するには「#」をつけるということまではわかっていたのですが、それ以外のやり方や簡単にコメント化する方法などもっと早く知っておけばよかったという内容もあったのでここに一通り載せておきます。

１．行の先頭に「#」をつける
２．行の途中に「#」をつける
３．シングルコーテーション３つまたはダブルコーテーション３つで囲む
４．簡単なコメント化の方法

１．行の先頭に「#」をつける

以下の１行目のように文の先頭に「#」をつけるとその行のそれ以降はコメントとして扱われます。

２行目のprint文はそのまま実行されます。

#abcdefをプリントする。
print("abcdef")

２．行の途中に「#」をつける

行の途中に「#」をつけると、「#」以降がコメントとして扱われます。

「#」の前のコードは実行されます。

print("abcdef")        #abcdefをプリントする。

３．シングルコーテーション３つまたはダブルコーテーション３つで囲む

これが一番わかりにくかったのですが、文字列はそれ以外の実行に影響しないということを利用したコメント化のやり方です。

この時に注意しなければいけないのがインデントです。

以前for文やif文に絡むような箇所で複数行コメント化しようとしてこれで囲んだことがあったのですが、はじめのうちは何回もエラーが発生しました。

具体例を挙げて見ていきます。

まずはじめに問題のない例ですが、以下のような例では、このようなシングルコーテーション3つによる囲みにて３，４行目がコメント化されるということで特に問題ありませんでした。特にインデントなどがされてないコードなのでこれはうまくいきました。

driver.get('https://www.yahoo.co.jp/')
element = driver.find_element(By.NAME, "p")
'''
element.send_keys("abc")
element.send_keys(Keys.ENTER)
'''

問題だったのは次のような場合でした。

for x in range(1, 5):
    if box != None:
        if value == "abc":
            s = "s1"
        elif value == "def":
            s = "s2"
        elif value == "ghi":
            s = "s3"

ここでたとえば２つ目のelif関連をコメント化したいと思った時に、

以下のように直感的にこうかと思ってやったところエラーになりました。

for x in range(1, 5):
    if box != None:
        if value == "abc":
            s = "s1"
        ''' 
        elif value == "def":
            s = "s2"
        '''
        elif value == "ghi":
            s = "s3"

それではと思って以下のように変えてみましたがこれもだめでした。

for x in range(1, 5):
    if box != None:
        if value == "abc":
            s = "s1"
        ''' 
        elif value == "def":
            s = "s2"
            '''
        elif value == "ghi":
            s = "s3"

そうすると、先頭から囲めばいいのかと思って

for x in range(1, 5):
    if box != None:
        if value == "abc":
            s = "s1"
''' 
        elif value == "def":
            s = "s2"
'''
        elif value == "ghi":
            s = "s3"

とやってみたのですがこれもだめでした。

最終的にうまくいったのはこれでした。

for x in range(1, 5):
    if box != None:
        if value == "abc":
            s = "s1"
            ''' 
        elif value == "def":
            s = "s2"
            '''
        elif value == "ghi":
            s = "s3"

「シングルコーテーション３つまたはダブルコーテーション３つによるコメント化の場合には、コーテーションをつけたコメントは直前の行のインデントにあわせる」ということになるようです。

終了側のシングルコーテーション３つはこの位置以外でも、もう半角４つ左の位置でもＯＫでした。