[Python]02章-04 コメントについて
この節では、コメントについて説明していきます。
ある程度章が進むと、プログラムも長くなっていき、後ほど見返すと何を書いていたかわからなくなることが良くあります。
不思議なことに、一度自分で書いたプログラムを次の日に見返すと、何を書いていたか全くわからなくなることが良くあります。
また、自身が部署の異動等で後任の方にプログラムを渡す際に、後任のがプログラムを読んでもさっぱりわからなくなってしまい、プログラムのメンテナンス時に困ることになります。
そこで用いられるのがコメントです。
このコメントでは、プログラム内にコメントを記載し、説明文を書くことができます。コメントには2種類ありますので、それぞれ見ていきます。
今回も、プログラムを書いて実行していく方法で進めていきたいと思います。
「#」を使ったコメントの記述について
まず、前回書いたプログラム02-03-05.pyをコピーして同じchap02内に02-04-01.pyを作成します。
以下のように、「#」を用いるとコメントを記載することができます。
#変数x,y,zにそれぞれ数値を入力する
x = input('変数x：')
y = input('変数y：')
z = input('変数z：')
#入力されたものをそれぞれ数値に変換してから足して、結果をwaに代入
wa = int(x) + int(y) + int(z)
#結果を出力する
print(x+'と'+y+'と'+z+'の和は' +str(wa)+ 'です。')
「#」より右側はプログラムを実行しても無視されます。
こののように、#を用いてコメントを記載すると、後でプログラムを見返したときに、わかりやすくなるというメリットがあります。
また、プログラムのデバッグ（※）の際にも、プログラムコードの1行部分を#でコメントアウトして、動作確認する際にも用いられます。
（※）デバッグとは、プログラムを実行して不具合（バグ）が発生した際に、そのバグを取り除く作業。
3つのシングルクオーテーションを使ったコメントの記述について
先ほど説明した#を使ったコメントは、1行のみしかコメントアウトできない状態です。
例えば、長文をコメントするとなると、わざわざ各行に#を入れなければならなくなります。
そこで用いられるのが3つのシングルクオーテーションを使ってのコメントです。
先ほど書いたプログラム02-04-01.pyをコピーして同じchap02内に02-04-02.pyを作成します。
以下のように、シングルクオーテーションを３つ記載して、長文をまとめてコメントアウトすることもできます。
'''
作成者：光
プログラム記載日：2020/05/16
プログラムの内容：3つの数を入力して和を求めるプログラム
'''
#変数x,y,zにそれぞれ数値を入力する
x = input('変数x：')
y = input('変数y：')
z = input('変数z：')
#入力されたものをそれぞれ数値に変換してから足して、結果をwaに代入
wa = int(x) + int(y) + int(z)
#結果を出力する
print(x+'と'+y+'と'+z+'の和は' +str(wa)+ 'です。')
最後に
今回はプログラミングというより、プログラミングで使えそうなネタを紹介しましたが、コメントアウトはよく実務上でも使用するものです。
適宜使用するように心がけてください。