ドキュメンテーション

コードには How
テストコードには What
コミットログには Why
コードコメントには Why not

を書こうという話をした https://twitter.com/t_wada/status/904916106153828352

コードコメント

• 基本的にはコードを読めばわかることは自然言語で書かない
  • コードの自己文書化を進める
  • コードの正しさをコードで表現できるのであれば、それに越したことはない