はじめに
先日インターン先で社内の技術ハンズオンのコードレビューをした。
インターン生がコードレビューをするということもあり、貴重な経験であると感じたので新鮮なうちにここに書き留めておく。
目次
1. コードレビューをするにあたっての経緯
2. コードレビューをする際に意識したこと
3. コードレビューをしてみて
コードレビューをするにあたっての経緯
私が現在インターンしている部署では、インターン生、正社員関わらずエンジニアが実際に仕事を受ける前にハンズオンを取り組むことによって必要最低限の技術を身につける。
去年の8月にインターン生としてアサインした私ももちろんそのハンズオンを取り組み、現在実務に取り組んでいる。
このハンズオンの内容としてはシンプルで、「指定した条件に沿うデータを擬似データベースから検索、参照するAPIを実装する」といったもので、この部署でエンジニアとして立ち回るための最初の課題になっている。
そして11月に私が務める部署にアサインされた新卒社員の方がこのハンズオンに取り組むことになった。
基本的にこのハンズオンは実装の後にレビューしていただいて合格をもらえれば「ハンズオン修了」となる。
そのため、本来ならば先輩社員の方が新卒社員が取り組んだハンズオンのコードレビューをする。
しかし、最近ハンズオンを経験した私は良い復習になるかもと感じ、先輩にお願いしてコードレビューをさせていただくことになった。
コードレビューをする際に意識したこと
ここで、実際にコードレビューをした際に意識したことを以下にまとめたい。
私が意識したことは以下三つである。
- ロジックの整合性（APIとして正しく動作するか、無駄がないか）
- 変数名などの可読性（変数名は読みやすいものになっているか）
- コード全体の可読性（適切にコメントを使っているか、変に冗長なものになっていないか）
主にチームで開発することを踏まえて、チームメンバーが読みやすいコードになっているかどうかを念頭に入れてコードレビューした。
これは私がハンズオンに取り組んだ際、先輩レビュアーの方からおすすめされた書籍で培った考えである。
その書籍が以下にある『リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック』である。
かなり有名な書籍なので、おそらく既に読んだことがある方も多いと思うが、この書籍はチームで開発する際には必須といっても過言ではないものなので是非お勧めしたい。
コードレビューをしてみて
以上のことを意識して実際にコードレビューを行った。
全体を通して、コードレビューは個人的に興味深かった。
まず同じハンズオンに取り組んでいても、人によって全くコードの書き方やロジックの組み立て方が異なる点が面白かった。
この点に関しては、コードレビューをすることによって感じることができたと思う。
また、可読性を意識したレビューをすることによって次に自分がコードを書く時に注意することができるのでそれも恩恵に感じられた。
もちろん可読性以外にもコードレビューはさまざまな観点が存在すると思うので、次回からはさまざまな視点を持ってレビューしたいと感じた。