Pythonでプログラムを書いていると、コメントを追加したり、不要なコードをコメントアウトしたくなることがあります。
そこで今回は、初心者の方にもわかるように、Pythonでのコメント・コメントアウトの書き方を紹介します。
コメント・コメントアウトとは？
まずはコメントについて簡単に紹介します。
コメントとは、作成したコードの目的や使い方などを第三者にわかりやすく説明するためのものです。他人が書いたコードを理解するのは大変ですからね。
また、実行させたくないコードを無効化するときにもコメントを使います。この無効化するためのコメントをコメントアウトと言います。
コメントやコメントアウトの書き方
では早速、コメントの書き方について紹介します。
Pythonではコメントに「#」（シャープ）を使います。行中の「#」以降に書いたコードはすべて無効化されます。
次のサンプルプログラムをみてください。
◆サンプルプログラム：
|
1 2 |
print('Hello World1') # print('Hello World2') |
◆実行結果：
|
1 |
Hello World1 |
「Hello World2」のprint処理が無効化されていることがわかりますよね。これがコメントアウトです。
print関数について知りたい方は、以下のエントリを参考にしてください。
また、次のように行の途中にコメントを書くこともできます。
◆サンプルプログラム：
|
1 2 3 4 5 6 7 |
sum = 0 for i in range(5): #loop 0-4 sum = sum + i #sum # sum = sum + i print('sum:', sum) #print sum |
◆実行結果：
|
1 |
sum: 10 |
このように、コメントは処理の内容を説明したり、不要な処理を無効化するときに便利な機能です。
複数行をまとめてコメントアウトする方法
先ほど紹介した「#」を使った例では、行中の「#」以降に書かれた処理を無効化することができました。
しかし、複数行をまとめて無効化したくなることもありますよね。そんなときは、「#」を複数行にわたって書いてもいいのですが、もっと便利な方法があります。
それは、「’」（シングルクォート）または「”」（ダブルクォート）を3個つなげた「”’」or「”””」（トリプルクォート）を使って該当箇所を囲む方法です。
言葉ではわかりにくいと思うので、次のサンプルプログラムをみてください。
◆サンプルプログラム：
|
1 2 3 4 5 6 7 8 9 |
sum = 0 ''' for i in range(5): #loop 0-4 sum = sum + i #sum # sum = sum + i ''' print('sum:', sum) #print sum |
◆実行結果：
|
1 |
sum: 0 |
「for文」をすべてコメントアウトしたので、sumの値が初期値0のまま出力されましたね。
「for文」について知りたい方は、以下のエントリを参考にしてください。
最後に
今回は、Pythonのコメント・コメントアウトの書き方について紹介してきました。
プログラミングをしていると、コメントを書いたり、コメントアウトしたくなる箇所がいろいろ出てくると思うので、ぜひ習得してください。
