今回はpythonのプログラムコード内にコメントを入れる方法を解説したいと思います。
分かりやすいプログラムコードを書くためには必須のテクニックですので早いうちに覚えて使っていきましょう。
では早速本題です。
目次
コメントとは？
まずプログラミング初心者の方からすればコメントって何？という疑問があると思いますので簡単に説明します。
コメントとは簡単に言うと
メモやプログラムコードの説明のために入れる実行に無関係な文(文字)の事
です。例えば友達が書いたコード自分が引き継ぐということを考えてみると，説明なしではなかなか理解出来ないですよね？
そんな時にコメントを入れて補足するわけです。
※コメントを入れる意味みたいなところは書く人や読む人によって変わるかと思います
あとコメント入れた方がコード全体がカッコよく見えたりします(僕だけかもしれない)！
もう一つ使用する場面として，説明やメモ以外に，ある部分のコードを実行したくないときにも活躍します。
つまりプログラムコードを一時的にコメントにすることで実行を無効化するわけです。
この場合は”コメントアウトする”という風に表現するので覚えておいて下さい。
コメントの種類と実装
コメントの種類は2つあります。
インライン(単一行)コメントとブロック(複数行)コメントです。それぞれ使い方をご紹介します。
インラインコメント
単一行をコメント化します。
該当行の#以降をコメント化するため，その行の命令に対するメモとして使いやすいです。
他にも命令群の前に説明として入れる事も良いかと思います。
それでは例です。
# 0からNまで出力する
N = 10
for n in range(N+1):
print(n) # ここで出力
こんな感じですね。
ブロックコメント
“””から次の”””までをコメントとして認識します。
複数行コメント化できるので，関数の説明や，命令群のコメントアウトに便利です。
上で書いた命令を一気に全てコメントアウトしてみましょう。
"""
# 0からNまで出力する
N = 10
for n in range(N+1):
print(n) # ここで出力
"""
いちいち全部の行をコメントアウトする必要がないので便利ですね。
ちょっとしたテクニックをついでにご紹介します。
ブロックコメントの有効化・無効化のテクニックです。
考えてみればすぐ分かるのですが，これ実は結構便利ですので使ってみて下さい。
先程のブロックコメントを無効化してみましょう。
# """
# 0からNまで出力する
N = 10
for n in range(N+1):
print(n) # ここで出力
# """
つまり
#によって”””自体をコメントアウトするわけです。
ただし，テキストエディタによっては選択+何かのコマンドで複数行のコメントアウトはもっと簡単にできたりしますので一度調べてみることをおすすめします。
まとめ
今回はpythonでのコメントの使い方とちょっとしたテクニックを解説しました。
プログラムは(特に他人が見る可能性のあるプログラムは)可読性が非常に重要なファクターになります。
これについて，もちろんプログラム自体を効率的に書くということも重要なのですが，意外とコメントを分かりやすく書くということも重要だったりします。
他人が読む予定がないコードでも習慣づけのため，たまに意識してコメントを書いてみるのも良いと思います。
では皆様楽しいプログラミングライフをお過ごし下さい！
