なぜこの記事を書くか
検索すれば、実装時の注意、コードレビューの時の注意点は書いてあると思うので、これは完全に自分用のメモ 特に失敗してしまったこと自分の言葉で書いて、次に同じことが起きないようにする。
粒度大きめ＞粒度小さめ の順番で書いていく
実装するとき
- 仕様がある場合は仕様を把握する
- 仕様で漏れがないか、わからない点がある場合、確認事項をリストアップし早めに確認しておく
- 仕様がない場合は、出来上がりのイメージを確認したり、仕様を作っていく
- 既存のコードを使う場合、既存コードが何を担保しているか、把握する
- 一つのメソッドが何百行とかになってないか
- 繰り返し出てくるメソッドをまとめられないかどうか
- メソッドの変数名がわかりやすいかどうか
- プロジェクトのコードルールに則っているか
- コメントが分かりやすく書かれているか
- typoがないか
順番に依存したコードを書く場合、意図した順番が担保されているかを確認する
例外処理が書かれているか
- テストをかいたか
- テスト内容は網羅的で（抜け漏れのない）必要最小限のテスト項目か
コードレビューするとき
- 上記のような実装の観点で実装されているか
- リリースまでの流れの中で不安な点、明確になっていないものはないか
- 大きな機能は実装方針など詳細設計の時点でレビューしたいと実装者に伝えておく
コードレビューしてもらうとき
- 工数がかかる実装は特に、詳細設計、方針など早めに共有しておく
- 何を特にレビューしてほしいか伝える
他にもいっぱいある気がするがとりあえず思いついたときに、 追加したくなったときに追加していきます。
