コードコメントにはWhy not

コードにはHow
テストコードにはWhat
コミットログにはWhy
コードコメントにはWhy not
を書こうという話をした
https://twitter.com/t_wada/status/904916106153828352

t-wadaさんの超便利ツイート。あらためてページに起こしてメモしておく。

HWWWn（はわわわん）の原則
https://twitter.com/t_wada/status/935042169655533568

HWWWnの原則という名前がついていたのか〜。

ぼくはこの中で、タイトルにもした「Why not」の説明がいちばん好き。Why notってだいたいコードレビューでコメントが入りがちで「素直に設計したら◯◯になると思うんですけど、なぜそうしなかったのですか？」と聞きたくなるところに気の利いたWhy notが置いてあると、やりとりが一往復へって最高に捗る感じがするからです。

この「一往復を節約する」ってのは共同作業全般においてぼくが重視したいことなんだろうなあ。これの積み重ねでタスク完了までに要する時間が大きく変わってくる、という感覚がある。