ソースコメントも理路整然に
ソースコメントにはWhy notを書くのが良いと言われている。 (ソース意図について5W1Hに関する情報はコミットログから読み取れるため)
そんなソースコメントについて、口語体で開発者の実装当時の気持ちが見え隠れするようなコメントを見かけることがある。
...きっと実装が大変だったのだろう。
でもそんな時こそもう一息入れて最後までやりきろう。
ソースは一行一行、一言一句、こだわりぬいて書くものである。それはコメントもしかり。
ソースをロジカルに考えて書く力があるのだから、コメントも理路整然と書こう。
将来の読み手の負荷低減に繋がる。
このソースを書いた人は果たしてロジカルに考えられる人なのか?という疑心は、
自動車の運転が荒い地域をいつもより気張ってかもしれない運転するように徐々に身体の疲労に響いてくるのだ。