👋

他部署向けにざっくりコードレビューについて解説!

2022/12/17に公開約1,400字

コードレビューとは?

エンジニアには他人が書いたコードをチェックするという業務があります。
コードレビューとは - IT用語辞典

コードレビューの方法?

GitHubにアクセスして実装したコードを目視で確認するのが基本になります。
(octocatから引用。赤が削除分、緑が追加分)
スクリーンショット 2022-12-17 8.33.50.png

目視で確認するの面倒じゃない?

自分のPCにレビューするコードを取り込むこともできます。メリットはコード編集ソフト(エディタ)でコードを検索したり、(必要に応じて)書き方を統一してくれるといった点があります。

そのコード本当に動くの?

レビューをお願いした段階でコードが正しく動作することが前提としている開発組織が多いです。
コードレビューで行うのは基本的にコードのレビューだけになり、それ以外のこと(設計や仕様など)のレビューは別機会で行うことが多いです。

通常、CL がコードレビューに至るまでには、コードが正しく動作することを開発者が十分にテストしていると期待できます。 それでもレビュアーはエッジケースを想定する、並行処理の問題を探す、ユーザーになりきって考えるなど、コードを読むだけではわからない不具合がないかを確認してください。

※CL(Critical Limit)は管理基準のこと
Google's Engineering Practices documentation 日本語訳から引用

コードレビューよりバンバンコード書いた方がいいのでは?

以下のようなことを考えるとメリットがあります

うっかりミスをなくせる

スペルミス(apple→appel)等をなくせる

コードのレベルが上がる

極端な例ですが、無駄な記述しか知らない人にとっていい気づきになるかもしれません

1 + 1 - 1 + 1 = 2

1 + 1 = 2

クセや属人性を極力なくせる

例えば丸いボタンをクリックした時のプログラム名をcircleJostleにしたとしましょう。
circleJostleという単語を見た時にボタンをクリックというイメージがわきますでしょうか?
と考えた時に関数名をclickButtonなどに訂正することをレビューしてあげる必要があります。

※jostle:押し返す

Discussion

ログインするとコメントできます