コメントを書く

行の途中から # を書けば、その行の残りだけがメモになる。前半のコードはちゃんと動くよ。

見やすくするために、コードとの間は空白2つ空けるのが慣習だよ。

# はメモ以外にも使える。動かしたくない行の先頭につけて、一時的に消すという使いかただよ。

これを「コメントアウトする」と言う。消してしまうと戻すのが大変だけれど、# なら外すだけで復活する。動かない原因を探すときに大活躍するよ。

コメントに書くべきなのは、コードを読めば分かることではない。

• ✕ print(x) # x を表示する … 見れば分かる
• ○ print(x) # 動作確認のため一時的に出している … 見ても分からない

書くのは「なぜそうしたか」。コードは「何をしているか」をすでに語っているからだよ。

3日後の自分は、他人だと思ったほうがいい。「なんでこう書いたんだっけ?」は必ず起きるよ。

そのとき助けてくれるのが、書いた瞬間には当たり前すぎて省きたくなるひとことなんだ。

ただし書きすぎにも注意。コメントだらけのコードは、コードが説明不足なサインでもある。まずは読みやすいコードを書いて、足りないところだけコメントで補おう。

コメントは日本語で書いて問題ないよ。実行されないので、Pythonは中身を見ていない。

自分がいちばん速く読める言葉で書くのが正解。無理に英語にして意味が薄れるほうがもったいないよ。