logo
/
セルフレビュー
指差し確認に通じるところがあり、明示的に自分がチェックするという立場に立つことで、作業者側では見えないことが見えてくる

チェックリスト

※コード規約にそっていることは前提

変数/関数の命名が一目でわかるものになっているか

  • 何がおきてるかはわからんが、何がおきるのかは分かる

説明のつかないコードが含まれていないか

  • コピペ、理解してないけどとりあえず書いたというのがあると後々辛いぞ

不要なステップが含まれていないか

  • 無駄な if がないか

コメントは適切か

  • コードを理解する最小限のコメントはあるか
  • 多すぎるコメントはそもそもコードの書き方が間違ってるんじゃないか

関数が大きくなりすぎていないか

責務を分けて、それをまとめた関数にすることはできないか

同様の処理が既存に存在していないか

美しくない=わかりにくいコードになっていないか

  • ぱっと見美しくないコードは、無駄なステップとか深いネストとかがあるから直してみよう

参考リンク

Pull Request のセルフレビューでやっていること
今日から始めるセルフレビュー