【Python】コメントの書き方【入門第38回】
目次
コメントとは？
こんにちは、narupoです。
今回はPythonのコメントについてやっていきます。
コメントを使えるようになると、プログラムにメモ書きや覚え書きを書いておくことができるようになります。
これらのコメントはあなたのコードを読む他の開発者や、未来のあなた自身を助けることになるでしょう。
ある開発者は、コメントを「未来の自分へのラブレター」と例えました。
それは言い得て妙で、まさに開発者がそのラブレターで救われることは多いと言えるでしょう。
具体的には↓を見ていきます。
コメントの書き方
コメントの役割
コメントの活用例
コメントの書き方
Pythonのコメントはシャープ（#）で始めます。
#以降の文章やコードは、すべてコメント扱いになります。
Pythonインタプリタは実行時にこのコメントをすべて無視します。
コメントは↓のように書きます。
:::python
# これはコメントです
#以降の文章は、改行までがすべてコメント扱いです。
何度も言いますがPythonインタプリタはこのコメントを無視します。
なので↑のコードを実行しても何も起こりません。
コメントは複数行書くことも出来ます。
:::python
# にんにくと
# お肉を合わせて
# おいしいね
複数行書いても、理屈は同じです。
#で以降の文章は改行までコメントです。
↓のようなコードはどうなるでしょうか。
:::python
# にんにくと
print('キャベツと')
# お肉を合わせて
print('タレをかければ')
# おいしいね
コメントは改行までなので、途中にあるprintはふつうに実行されます。
↑のコードを実行すると↓のような結果になります。
キャベツと
タレをかければ
また、#の前にあるコードはコメント扱いになりません。
なのでたとえば↓のようなコード。
:::python
print('ヒゲ') # と私
↑のコードを実行するとヒゲと表示されます。
コメントの役割
コメントの書き方はわかりましたが、これの使い道はあるのでしょうか？
実は、プログラミングにおいてコメントというのは、とっても重要です。
コメントは、コードを補足するのに使われます。
見た感じ、どういったことをやっているのかよくわからないコードというのは、世の中には非常に多いです。
そのコードに対して、コードが何を目的に何をやっているのかコメントで補足すると、コードを読む労力が圧倒的に少なくなります。
コードを読む……という作業は、実はプログラミングではかなりの割合を占めています。
過去に書いた自分のコードを読んで、新しい実装に取り掛かる……ということは、かなり一般的なことです。
そのコードを読むという作業の負担や労力を減らせるのがコメントです。
コメントを適所適度に書いておけば、将来の自分や他の開発者のコードを読む労力を減らすことができるのです。
これがコメントを書く一番の理由です。
コメントが整備されているプロジェクトは、コメントが整備されていないプロジェクトより一般的に言って品質が高いと言えるでしょう。
また、コメントを書くことで総合的なプロジェクトの労力も軽減することが可能になります。
まさにあっぱれコメント！ といった感じですね。
その他にもコメントは、デバッグの時などに使われます。
コードをコメントにすることをコメントアウトするといいます。
特定のコードをコメントアウトして、プログラムの動作を変えてデバッグします。
このコメントアウトは、エディタによってはショートカットキーで出来ることが多いです。
Visual Studio CodeやSublimeText3などはCtrl+/でコメントアウトができます。
コメントの活用例
コメントを使ったデバッグ方法を1つご紹介します。
たとえば↓のようなコードがあります。
:::python
create_cats()
create_dogs()
create_birds()
create_pigs()
関数を立て続けに呼び出しているコードです。
↑のコードを実行すると、プログラムが異常終了してしまったと仮定します。
↑の関数の呼び出しのどこかでプログラムが異常終了していることがわかっています。
どこで異常終了しているのかデバッグしてみましょう。
まず、関数呼び出しの半分をコメントアウトします。
:::python
# create_cats()
# create_dogs()
create_birds()
create_pigs()
↑のように上半分をコメントアウトしました。
再度コードを実行すると、異常終了が起きませんでした。
ということは、コメントアウトしている2つの関数のどちらかで異常終了が発生しているということになります。
そこで、さらに↓のようにコメントアウトしてみることにしました。
:::python
# create_cats()
create_dogs()
create_birds()
create_pigs()
↑のようにコメントアウトしてコードを実行すると、ふたたび異常終了が発生しました。
ということは、create_dogs関数内で異常終了が発生していることがわかります。
これでめでたくデバッグは終了です。
このように、探索範囲を1/2, 1/2と狭めていく方法を2分探索といいます。
↑はコメントアウトによる2分探索の例でした。
おわりに
コメントを使えるようになると、たとえば自分のプログラムにポエムを仕込んだり、格言を書いたりすることも出来ます。
まぁ経験上、あとになって必ず恥ずかしくなって消すと思いますが。
Git（バージョン管理ソフト）で自分の黒歴史も管理するとかなかなか素敵ですね。
以上、次回に続きます。
また見てね