先輩のエンジニアにしょうもないレビューをさせないためのTips

はじめに

最近、先輩エンジニアにレビューをしてもらう機会が増えました。
レビューをしてもらうと、自分のコードに気づかなかったことが見えてきて、
自分のコードの質が上がると思います。　by Github Copilot

いいえ。私はそう思いません。
レビューをしてもらっても、自分のコードを書く意識を変えることができなければコードの質が上がることはありません。

この記事は、自分の書くコードの質に対して本当に辟易したため作成しました。
この春から新しくエンジニアになる人。まだまだジュニアなエンジニアの方に読んでもらい、反面教師としてほしいです。

コードの質を改善しなかった結果、どんな気持ちになっているのか

PRを作成することが本当に嫌になりましたし、怖いと感じることが増えました。
どうせ見落としがあるんだろう。どうせまたしょうもないミスが隠れているんだろう。という気持ちがどんなに見返しても消えません。

どんなミスをしているのか

以下には、主なミスとその原因に関して書き下しています。
もし、自分が書いたコードに当てはまるものがあれば、自分のコードの質を改善するために、早急に対策を行ってください。

使っていないXXがある

• 使っていない変数がある
• 使っていないimportがある
• 使っていない関数がある

原因

• コードを書いているときに、コピペをしている
• とりあえず書いておいて、後で使うかもしれないと思っている
• 使っていない変数を使うように書き換えるのを忘れている
• IDEの設定でコードフォーマットをするように設定していない

コード規約が守られていない

• コードのフォーマットが行われていない
• 配列を扱うオブジェクトの変数に複数形が使われていない
• 同じものを扱っている変数に表記揺れがある

原因

• IDEの設定でコードフォーマットをするように設定していない
• 表記を統一するように意識していない
• コードを書いている自分が理解できれば良いと思っている

触っているシステムを理解しきれていない

• システムのオブジェクトを正しく理解できていない
• システムの思想を考慮できていない

原因

• 「多分こうだろう」と推測する

機能の実装が脆い

• 非効率的なコードが書かれている
• 求められている機能を実装できていない
• テスト観点が不足している
• 誤字が含まれている
• 他のエンジニアが読むときに理解しにくいコードが書かれている

原因

• とりあえず動くコードを書いている
• テストの観点はこれくらいでいいだろうと思っている
• 他のエンジニアが読むことを考えていない
• 読みやすいコードがイメージできていない

おわりに

繰り返しになりますが、上記はそれぞれ本当に初歩的なことです。
初歩的なことだからこそ、対策も簡単です。しかし、何も意識せずに全てできるようになるまでには時間がかかると思います。

どんなに複雑なコードを書けたとしても、上記のようなミスが頻発すると、レビューをしてもらうときに先輩エンジニアにしょうもないレビューをさせてしまうことになります。

これらミスはコードの質の向上に寄与しません。
システムへの議論も生みません。新しい発見もありません。
何よりも、先輩エンジニアに「こいつのPRをレビューしたくない」と思わせることになります。
「こいつのPRは細かいところにミスがあるぞ」と思わせてしまうのは本当に無駄なことです。