はじめに
今回はコードレビューについて私が意識していることをまとめます。 今後アップデートがありそうな項目なので、備忘も兼ねて記述していきます。
コードレビューで主に意識していること
複雑な部分や意図がわからない部分に注視
みなさまはコードレビューにおいて、特にどの部分を見ているでしょうか？ 差分を隅から隅まで見ている方もいるでしょうが、私は掲題にもある通り、複雑な部分や意図がわからない部分にフォーカスしてレビューしております。 バグはテストで取り除かれるべきなので、バグを意識的に探そうとしないということを意識しています。 複雑な部分と前述しましたが、複雑さはバグを呼び寄せるので、できればシンプルである方が良いに決まっています。 そのため、複雑な箇所で何を実現したいのか、よりシンプルに実現できないのかをレビューイと協力して考えます。 個人的にコードレビューの1番楽しい点です。
コミュニケーション
前項の最後でも触れましたが、コードレビューがレビュアーの打ち返しだけで終わってしまうのはとても勿体無いと思っています。 それだけでもレビューイの成長につながるとは思いますが、せっかくならそれをより増幅させたいですし、レビュアー側も成長できる場にしたいですよね。 私が心がけているのは、レビューイが何を思ってそのコードを記述したのかを知ることです。 変数名1つとってもソースコードではとても大切な要素だと思っているので、なぜその名前にしたのかなど気になる箇所は質問してみたりするとレビュアー側も新しい発見があり楽しいです。 こういうちょっとしたコミュニケーションでも双方に成長機会があるので、ぜひ続けていきたいことです。
不要なものがコード内にないか
最後は当たり前ですが、意外と多くのプロジェクトで目にしてきました。 以下2点のソースコードです。
- 過去の遺物が残っていないか
- 将来に必要なものはないか
上記のものを残したい気持ちはわからなくもないですが、だんだんとゴミだらけになってしまいます。 YAGNI原則のとおり、必要になる時までコードは書かないを意識していきたいですね。 きっと使うだろうは、きっと使いません！笑
さいごに
コードレビューの観点について記述しました。 こちらは今後の経験をもとにより良い資料にしていければと思います。 今回は以上となります。 別の記事も執筆しておりますので、みていただけると嬉しいです。 よろしくお願いいたします。
