【Python入門】コメントを書く方法について！(1行/複数行)

Pythonでコメントを書く方法について書いています。

コメントはソースコードに説明を付けることができる機能です。
ソースコードの中で、コメントした箇所にはプログラム実行時には無視されます。

載せているコードについては、Pythonの3.11.0バージョンを使って検証しました。

1行コメントを書く

Pythonでコメントを書くときには、シャープ(#)を使って記載します。
下記のようにコメントを付けることができます。

# 果物のリストを作成
fruits = ['apple', 'banana', 'orange']

# リストがある間ループ
for fruit in fruits:
    print(fruit)

シャープ(#)を使ってコメントを入れました。
fruits変数にリストを作っている箇所と、for文でループしている箇所です。

このようにシャープ(#)を使うことで、コメントを書くことができます。
プログラムの実行時にはコメントは無視されます。

先ほどのプログラムでは、行頭からコメントが始まっていましたが、行の途中からコメントにすることもできます。
例えば、下記のように使います。

fruits = [
        'apple',  # りんご
        'banana', # バナナ
        'orange'  # オレンジ
    ]

リストの内容を改行して、それぞれにコメントをつけてみました。
このように行の途中からコメントすることもできます。

Pythonには複数行コメントが用意されていません。
そのため、複数行コメントしたいときには、下記のようにシャープ(#)を複数使ってコメントをします。

# ===============
# 挨拶するだけの関数
# ===============
def hello():
    print('hello!!')

もしくは、文字列を複数行で書ける機能を使って、コメントされることもあります。
下記のようにすると、文字列行は無視されるため、複数行コメントとして使うことができます。

'''
===============
挨拶するだけの関数
===============
'''
def hello():
    print('hello!!');

シングルクォーテーションを3つ(''')重ねて、改行し、終わりも同じようにシングルクォーテーションを3つ書きます。
そうすると、複数行の文字列を作成することが可能です。
もしくはダブルクォーテーションを3つ(""")重ねても良いです。

これで変数に代入しない場合には、実行時には文字列は無視されるので、複数行のコメントとして使えます。

コメントアウトはソースコードをコメント化して、処理を実行されないようにしておくことです。
使われなくなったけど、そのうち使う予定がある処理や、もしかしたら使うかもしれないものは残しておくことがあります。

# hello2を作ったからコメントアウト
# def hello():
#    print('hello!!');

def hello2():
    print('hello!!!!');

上記は、hello関数をコメントアウトで残して、hello2関数を作っています。

Gitなどでソースコードを管理している場合には、コミット時のソースコードが取り出せます。
そのため、しっかりとソースコード管理しているときには、不要なソースコードは削除しておいた方が見やすくなるかと思います。

今回はPythonでコメントを書く方法について紹介しました。

コメントの付け所は、それぞれの人に任せられますが、基本的には簡単な処理にはつけなくて良いかと思います。
コメントをつけなくても、ソースコードを見ただけでわかりやすい処理になっていることが理想ではないでしょうか。

複雑な処理を書いた箇所や、プロジェクトでコメントの付け方が決まっているところにつけていきましょう。