こんにちは、kazuです。
本日はコードレビューは嫌いですか??という
エンジニアにとって避けられないコードレビューについて記事にしていこうと思います。
コードレビューとは
エンジニアにとってコードレビューは当たり前のようにありますが、一応コードレビューについて説明をします。
コードレビューとは開発が完了して自分の書いたコードを第三者に確認してもらうことを言います。
コードレビューは重要な役割を果たしています。
1.不要なコードを削除するきっかけになる。
2.デグレードを防ぐことができる
3.見やすいコードにすることができ品質をあげることができる
等役割を果たしています。
経験が浅いエンジニアは指摘が多い
でも中にはコードレビューが嫌いな人も多々います。
多分ですが理由としては以下のようなことが挙げられるのではないかなと思います。
1.「動いているんだから問題ないじゃん」という動けば問題ないと思っている人
2.「こんなところ指摘するか普通」とか思っている人(例えばimportの消し忘れとか。インデントの間違いとか。笑)
3.とにかく忙しい(タスクが多すぎてレビューに時間をさきたくない)
等いろいろあるのではないでしょうか?
特に浅いエンジニアには上記に当てはまるので?
期限が決まっていながら「あーーまた指摘かーーーー」的な。笑
まぁ自分も当てはまっていたので気持ちはわかりますが。。。
でもコードレビューは嫌いじゃない
少なくとも私はコードレビューが嫌いではありません。
理由としては勉強になるからです。
自分の知識不足で書けなかった方法をレビューで指摘をくれるからです。
それにコードレビューのために時間をわざわざ貴重な時間を頂けているんですよ!
ほんとに感謝しています。
でもこれがわかるのって自分がコードレビューする立場になってからなんですよね。。
私もまだまだ未熟なプログラマーですが、新人のコードレビューや現場のコードレビューをする立場にはなりました。
先程も書いたのですがコードレビューって結構時間がかかるんですよね
gitからチェックアウトやプルしてきて場合によっては手順を踏んでアプリを動かす、
そのあとようやくコードを確認する。
簡単に書いていますが、これってすごく時間がかかるんですよね。
特に忙しい時なんかは結構きついんですよね。
それを自分のために時間を割いて確認してくれる(もしかしたら残業しているも)。
なんかこう考えるとどうもコードレビューって嫌いになれなくむしろ好きなんですよね。(あ、Mじゃないよ。笑)
実際にどういう指摘が来るの?
こうコードレビューってこういうことなんだよって語ったところでどのような指摘が来るのかあまりわからないと思います。
私が実際に受けた指摘を一部紹介しようかと思います。(コード自体はサンプルです)
1.変数名をわかりやすく、余計なコードは削除して、インデントを整えて
var text = "合格";
var text2 = 100;
if(text2 > 80){
console.log("通りました");
var htmltext = document.getElemntById("passingScore");
score.innnerHTML = text;
}
これ分かりますか?
難しいコードではないのでわかると思いますが、
これが複雑になるとわからん部分になりますよね?
ですのでこれを指摘をいただき以下のように修正しました。
var passText = "合格";
var score = 100;
if(score > 80){
var passingScore = document.getElemntById("passingScore");
passingScore .innnerHTML = passText;
}
指摘頂いた分を修正したら見やすくなりましたよね?
ではせっかくなのでもう一つ
2.三項演算子にすれば見やすくなるのではないでしょうか?
var score = 80;
if(score > 70){
console.log("試験合格です");
} else {
console.log("試験不合格です");
}
当時私は三項演算子という存在を知りませんでした。
それをレビューで指摘されてこういう書き方もあるんだと知りました。
それが以下の修正になります。
var score = 80;
let passingScore = (score > 70) ? "試験合格です" : "試験不合格です"
console.log(passingScore);
実はこれ書き方違うのですが出力は同じなのです。
こういう新しい発見があるのもコードレビューをしてくれたからになります。
最後に
いかがでしたでしょうか?
今回は少し変わってコードレビューについて記事にしていきました。
コードレビューは大事ということを少しでもわかって頂ければと思います。
最後までご覧いただきありがとうございました。
(おまけ)コードレビューがあるプログラミングスクール
テックアカデミー
選抜された現役エンジニアから学べるオンラインに特化したプログラミングスクールになります。
自宅でプログラミングやアプリ開発を学ぶことができます。
