TL;DR
- 「あえてやらなかったこと」をコメントしないと、レビュワーからは「知らなくてやった」と認識される
- 「あえてやらなかったこと」は、ほとんどの場合、ちゃんとコメントしておかないと理解してもらえない
- 「あえてやらなかった」ことを記載すると、レビュワーのコードリーディングの負担が減る
何が問題か
- 「あえてやらなかったこと」 = why notは、言語化しない限りは「知らなくてやらなかったこと」として認識される。
- レビュワーは「あえてやらなかったこと」だとわかっていれば指摘しなくても済んだ内容を指摘せざるを得なかったこと
- 後でコードを読んだ人も、そのコードにならってコピペでコード実装する可能性があり、パフォーマンス低下の温床になる可能性があること
どうしたらいいか
- コードコメントには、「あえてやらなかったこと」 = why notを書こう