Python コメントの書き方

Python学習【365日チャレンジ!】29日目のマスターU(@Udemy11)です。

29というと、やっぱり【にく】の日ですよね。

29日間きっちりと投稿を続けられたので、ご褒美にお肉をいただきました。

激安大型スーパー「ラ・ムー」で購入したお肉でしたが、かなり美味しいトンテキができました。

トンテキ

あれだけ安いと、「ほんと大丈夫なの?」と安全面が心配になってしまいます。

それに、これだけキャッシュレスを推進しようという世の中にあって、支払方法はバリバリの現金のみ!

といいつつ、安さに負けてしまう自分がいるので、次は、激安巨大豚バラをつかって、本格チャーシューを作ってみたいと思います。

気分もお腹もいっぱいになったところで、今日は、若干息抜きの感じのするコメントの書き方を学習しました。

昨日の復習

昨日は、集合型の使いどころについて学習しました。
1つ目は、共通の友人を見つける際に使う方法、2つ目はリストにどんどん値を入れていって同じ種類はまとめて、リストに含まれる種類をすべて取り出す方法でした。

>>> a = {'X', 'Y', 'Z'}
>>> b = {'X', 'R', 'V', 'Y'}
>>> a & b
{'X', 'Y'}

&(アンパサンド)の代わりにdifference()を使っても、aかつbの集合を求めることができました。

>>> x = []
>>> x.append('banana')
>>> x.append('peach')
>>> x.append('apple')
>>> x.append('banana')
>>> x.append('peach')
>>> set(x)
{'banana', 'apple', 'peach'}

買った果物をリストに入れていって、重複したものを一つにして、どの種類の果物を買ったことがあるのか抽出するコードになります。

リストにどんどん入れていって、そのリストをset()で集合型に変換することで、購入したことのある果物の種類が抽出されます。

リスト型から集合型への変換だけでなく、リスト型からタプル型、タプル型から集合型に変換することも可能でした。

リスト型を辞書型にするためには、同じ数のindexを持ったリストをzip()でつないで辞書型にすることもできました。
リスト型だけでなく、タプル型でもzip()で辞書型に変換することができます。

>>> x = ('A', 'B', 'C')
>>> b = (5, 6, 7)
>>> dict(zip(a, b))
{'A': 5, 'B': 6, 'C': 7}

いろいろ試していろいろ失敗することでどんどんスキルが身につくので、失敗を恐れずにどんどん試していきましょう!

コメント

プログラムを少しでもかじったことのある人なら、当たり前にわかっているのがコメントじゃないでしょうか?

これから書くコードがどんな役割を持っているのか、コードを見ればわかるように説明を書くのがコメントです。

ただ、普通に説明を書いてしまっては、プログラムが正常に動作しません。

なので、コメントは、コンピューターがコードを読み込まないようにするためのもので、書かれているコードを読み込まないようにする場合は、コメントアウトとも言われます。

#を使ってコメントをする

Pythonの場合は、【#】を使ってコメントを書きますが、基本はコードの真上にコメントを入れます。

#空のリストaを作る
a = []
 
#リストに商品を入れる
a.append(1)
a.append(2)

このようにコメントを書きますが、ここまで細かく書く必要もなく、コードを見て、どのような動作をさせるのかを完結に書きます。
この例なら、「空のリストを作って商品を代入する」と1つにまとめて記載してもいいでしょう。

また、コードの右側にコメントを入れることもできますが、Pythonのコメントの書き方は、暗黙の了解で上部に記載するのがルールだそうです。

“””で複数行のコメント

#を使ったコメントは1行だけ有効です。
2行に渡ってコメントを書く際は、”””(ダブルクォーテーション3つ)でくくって記載します。

"""
コメント
コメント
コメント
"""

もちろん、行頭に#をつけて複数行のコメントにしても問題はありませんが、複数行に渡るときは、”””で囲むほうがいいかもしれません。

コメントは自分のため

WordPresを使ってサイト運営をする場合は、HTMLやCSS、PHPといった知識が必要になりますが、コメントが書かれていると、ここに追加のコードを入れたらいいんだなというのがわかります。

はじめてプログラムを見たときには、「なんだこれ?」なんて思っちゃうかもしれませんが、書かれているコードがどのような働きをするのかが書いてあれば、エラーが起こったとき、どこが原因なのか突き止めることもスムーズにできる場合があります。

なにより、自分が書いたコードにしても、どんな動作をするのかいちいち憶えてられないので、きちんと役割がコメントされていれば、メンテナンスもやりやすくなります。

もちろん、コメントだらけのプログラムは美しくないので、できるだけ簡潔に最小限のわかりやすいコメントを心がけましょう!

ということで、明日も元気にGood Python!