【Python】コメントを付ける方法

コメント

こんにちは!

皆さんは、Pythonでプログラムを書く際にコメントをつけていますか?

一人で開発をしている人は、あまりコメントを付ける癖がついていない人が多いかもしれません。

しかし、プログラムを作成していく際に、動作を確認するためにプログラムの一部をコメントとしてプログラムに影響しないようにする「コメントアウト」という手法はとても便利です。

この部分が無くなったらどういう動作をするようになるんだろうか?といった際に、プログラムを消したり加えたりすることなく、動作の確認ができるようになります。

また、複数人で開発する際には、コメントを付けるのは必須です。

そこで今回は、Pythonのプログラムにコメントを付ける方法について紹介していきます。

1. 1行のコメント

1行のコメントには「#」を使用します。

「#」以降の文字がコメントとされてプログラムには影響しません。

「#」以降には、日本語が書いてあっても問題ありません。

次のプログラムは、三角形の面積を表示するプログラムです。1行のコメントをつけています。

#三角形の面積を表示するプログラム
a = 2   #底辺
b = 3   #高さ

triangle = a * b / 2     # 面積を計算
print(triangle)     #面積を表示

実行結果

3.0

プログラムには、「#」の後に、日本語で説明が書いてありますが、エラーも無く、プログラムの動作には影響していませんね!


2. 複数行のコメント

Pythonでは、複数行にわたってコメントを書くこともできます。

複数行にわたってコメントを書くには、コメントにしたい部分を「”””」で囲みます。「”」が3つ分です。

次のプログラムは、三角形の面積を表示するプログラムです。複数行のコメントを「”””」で囲むことによりつけています。

a = 2
b = 3
"""
a = 20
b = 30  囲まれているこの部分はプログラムに影響しません
"""
triangle = a * b / 2
print(triangle)

実行結果

3.0

「”””」で囲まれている部分に、a = 20、b = 30 と書かれていますが、コメントであるため、プログラムには影響していませんね。

また、複数行のコメントを書く際に、1行のコメントアウトを複数行に使用しても構いません。

次のプログラムは、三角形の面積を表示するプログラムです。1行ずつ「#」を使うことにより、コメントをつけています。

a = 2
b = 3

#a = 20
#b = 30

triangle = a * b / 2
print(triangle)

コメントの方法は変わっていますが、実行結果は変わりません。


3. まとめ

いかがでしたか?

コメントには「#」を使う方法と、「”””」で囲む方法があります。

コメントは、コメントアウトに使えるので、開発がとても捗ります。

また、複数人で開発を行う際に、プログラムがどのような動作をしているかを伝えるのにとても役に立ちます。

1人で開発する際も、コメントを付けることによってプログラムが見やすくなります。

なのでしっかりとコメントを付ける方法を覚えておきましょう!

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です