Pythonのコメントの練習問題

3 か月後の自分が、この 100 が何なのか分からない

コードに書かれた数字は、それが何を意味するのかまでは教えてくれません。+ 100 と書いてあっても、送料なのか手数料なのか、書いた本人しか知りません。そして書いた本人も 3 か月後には忘れています。

そこで、動作に関係しないメモをコードに残せます。これを コメント と呼びます。Python では # から行末までがコメントになり、実行時には完全に無視されます。

Python

# 消費税は 2019 年から 10 パーセント
print(1000 * 1.1)

1 行目は実行されません。画面に出るのは計算結果だけです。# の行を 10 行に増やしても、実行時間も結果もまったく同じです。

# は行の先頭に置いても、コードのうしろに置いても構いません。うしろに書くときは、コードとの間に半角スペースを 2 つ空けるのが Python の慣習です。

Python

print(1000 + 200)  # 昼食と飲みもの

# より前の部分は普通に実行されます。ただし式の途中に書くと右辺が消えて SyntaxError になるので、コメントで無効化するときは行ごとに行います。

初心者がやりがちなのは、コードを日本語に翻訳しただけのコメントです。

Python

# 1000 と 200 を足す
print(1000 + 200)

これは読めば分かることなので、書いても情報が増えません。コメントに書く価値があるのは なぜそうしたか です。その数字がどこから来たのか、なぜその値でなければいけないのか。コードには書けない事情こそコメントの出番です。

コメントは Python に向けた言葉ではなく、あとで読む人間に向けた言葉です。その「あとで読む人間」は、たいてい 3 か月後の自分です。

なお全角の ＃ はコメントになりません。見た目は似ていますが SyntaxError です。クオートの中に書いた # も、ただの文字でコメントにはなりません。

関数 calc_with_memo を実装してください。引数は price1 と price2 の 2 つで、この 2 つの合計に送料 100 円を足した金額を数値で返します。

calc_with_memo(120, 80) なら 300、calc_with_memo(0, 0) なら送料だけ残って 100 です。

送料の説明コメントはひな形に用意しました。それを読んで足し算を書き、品物が 0 円のときの扱いについても、理由が伝わるコメントを自分の言葉で 1 行加えてください。コメントは結果の採点には含まれません。書いても計算結果が変わらないことを確かめるのが、この回の狙いです。

3 か月後の自分が、この 100 が何なのか分からない

Python

# 消費税は 2019 年から 10 パーセント
print(1000 * 1.1)

1 行目は実行されません。画面に出るのは計算結果だけです。# の行を 10 行に増やしても、実行時間も結果もまったく同じです。

Python

print(1000 + 200)  # 昼食と飲みもの

読めば分かることを書かない

初心者がやりがちなのは、コードを日本語に翻訳しただけのコメントです。

Python

# 1000 と 200 を足す
print(1000 + 200)

コメントは Python に向けた言葉ではなく、あとで読む人間に向けた言葉です。その「あとで読む人間」は、たいてい 3 か月後の自分です。

やってみよう

関数 calc_with_memo を実装してください。引数は price1 と price2 の 2 つで、この 2 つの合計に送料 100 円を足した金額を数値で返します。

calc_with_memo(120, 80) なら 300、calc_with_memo(0, 0) なら送料だけ残って 100 です。