どんな優秀なプログラマーでも、そしてどんなに良く出来たプログラムでもコメントは必要です。そして、よく出来たプログラムとは適切なコメントが為されているものであるというのが共通認識かと思います。
ここで学習すること
- #で始まる純粋なコメント
- 文字列のコメントとしての利用
説明
#で始まる純粋なコメント
まずは純粋なコメントです。
# この行はコメントです
「# で始まる」と書きましたが、その行の先頭が#で始まるという意味ではありません。その行の途中で#が登場しても構いませんが、そこからその行の最後までがコメントとして扱われます。
# 先頭が#で始まるコメント行
print("途中で#を使うコメント行") #途中とはここのこと
まず1行目は#が行頭に出てきたので、丸ごと1行がコメントです。途中で#がもう一つ登場していますが無関係です。
次にprint文の中で# が登場していますが、それは””で囲われた文字列の中身なのでコメントでは無く、print文の後の# から以降がコメントとして扱われます。
ちなみにブロックコメント(CやJavaでは/* xxxx */というやつ)は有りませんので、#をひたすら使います。とはいってもプログラムをするために準備したエディタであれば、おそらく範囲指定した上でコメントを指示すれば、勝手に行頭に#を挿入してくれることと思いますので、不都合は何も無いと思います。
文字列のコメントとしての利用
すでにPythonのソースコードをいくつか見たことがある人は、以下のようなコメントを目にしたことがあるかも知れません。
""" コメント1行目 コメント2行目 """
これは厳密にはコメントではありません。身も蓋もないですが文字列です。文字列を代入もせず何にも使わず放置しているような状態です。そして”””と”””で囲うと改行しても文字列として処理されることを利用してブロックコメントのように使っているのです。(”’と”’でも構いません)
となると、もしかして”と”で囲った文字列でもコメント代わりになるの？とお考えの方もいらっしゃると思いますが、全くもっておすすめしませんが可能です。
つまり”””(あるいは”’)をコメントして活用することは多々ありますが、言語仕様上は全くもってコメントでも何でもありません。
例えが良いかどうか分かりませんが、以下のコードをコメントと言い張るのと変わらないということです。
if False: print("絶対に表示されないからコメントとして活用できる！")
ちょっと脱線が過ぎましたが、理解を助ける意味は多少はありましたでしょうか。