見出し画像

Python コメントアウトの書き方

みなさんこんにちは、metchです🌻🍓🧡
今回はPython3でコメントの書き方について、
プログラミング初心者の方でもわかりやすく解説していきたいと思います。

コメントとは?

プログラムを作っているとき、
ソースコード内にメモを残したいときはありませんか?
どの言語でも、ソースコードを読みやすくするメモとして
コメントを利用します。

使用例

・ほかの人がソースコードを見たとき、
 分かりやすいように注釈としてコメントを入れる。
・後からプログラムを見たときに
 分かりやすくするために注釈としてコメントを入れる。
・プログラムがうまく動かないときに原因を突き止めるために、
 プログラムの中で一時的に実行させたくないコードをコメントアウトして  
 動かない状態にするためコメントアウトする。
・他の人が書いたプログラムでどこがどのような動作をしているのか、
 確かめるためコメントを入れる

このように、プログラムの一部をコメントすることを
コメントアウトといいます。
コメントアウトの方法は下の二種類あります。
#で1行ずつコメントアウトする方法と、”””で複数行コメントアウトする方法です。

1行ずつコメントアウトする方法


Python3で1行ずつコメントアウトするためには#を使用します。

#0を代入
a=0
print (a)
実行結果
0

🌻🍓🧡めちクイズ🧡🍓🌻

下のプログラムを実行するとどのような結果が得られるでしょうか?

問題1

a=0

a=1

print (a)

問題2

a=0
#a=1
print (a)

実際に実行してみると
問題1では1が出力され、問題2では0が出力されました。

このことからコメントアウトされた行の処理は実行する時には
無視されることが分かります。

では、行内に#があった場合はどうなるのでしょうか?

a=0  # 0を代入
print (a)

#から行の最後まではコメント化され、無視されます。

同じ行内に複数#があったときはどうなるのでしょうか?

a=0  #a=1  # a=2
print (a)


行の途中の一部分を範囲指定してコメントとすることはできません。
複数#が含まれていたとしても、
最初の#より後はすべてコメントになります。

複数行コメントアウトする方法


pythonで複数行コメントアウトするためには
シングルクォート’かダブルクォート”を3つ繋げた
トリプルクォート( ''' , """ )で囲みます。

a=1
b=0
"""
b=1+a
b=b+a
"""
print (b)

トリプルクォートを使用して、コメントアウトする場合には
前の行とインデントがあっていないとエラーになるので注意しましょう!

a=1
b=0
for i in range(5):
"""
b=1+a
b=b+a
"""
print (b)

実行すると IndentationError になりました。

コメントを書くときに推奨されているルールがあるので
気になる人はこちらをチェックしてみてください。

Error codes — pycodestyle 2.4.0 documentation

ぜひコメントを活用し、読みやすいプログラムをつくってくださいね!

いいなと思ったら応援しよう!

この記事が参加している募集