この記事は、リンクバルアドベントカレンダー2023の2日目の記事です。
はじめに
私は2023年度に入社した新卒エンジニアです。
新卒エンジニアにとって、コードレビューはプログラミングのスキルを向上させるために非常に重要なプロセスだと考えています。
実際に私もコードレビューでボコボコにされながら、様々なことを吸収できていると実感しています😇
この記事では、そのコードレビューを頼む前に自分で最低限確認するべき基本的なポイントを4つピックアップして、まとめました。
この記事の対象となる人
正直、書いてあることは基本的すぎるので、実務1ヶ月目で意識してできている人もいると思います。
なので、
🧑💻「実務に入って、コードレビューを頼む機会ができたけど、何を注意すれば良いかわからない」
👩💻「なんとなくコードレビューを出してるけど、基本的な箇所で指摘されることが多い」
という方が対象になると思います。
まあ、これは少し前の自分なので、過去の自分に一番見せてあげたいですね😂
1,タイポがないか確認する
タイポは簡単にいうと、タイピングのミス＝スペルを間違えちゃった😅
ってやつです。
わからない英単語は綴りを調べて、コピペする場合が多いので、そこまで、タイポにならない気がします。
わかったつもりでいて、間違って書いて、そのまま見落としたというパターンが厄介で、タイポが発生しがちだと思います。
並べられるとわかりますが、ぱっと見スルーしちゃいそうですね。
pritn "Hello World"
print "Hello World"
レビュー前に、全ての変数や関数を確認するのは、しんどいので間違えやすそうなものは書くときに少し意識してみるといいかもしれません。
あとは、テキストエディタの拡張機能でタイポをチェックしてくれるものなどもあるので、そのような機能を活用するのもありですね！
2、インデントが正しいか確認する
インデントはコードを読みやすくするために、行の頭に空白を入れて、字下げするやつです。
以下の例だと、関数の中身が字下げされていて、
「ここからここまでが中身だよ〜」っていうのがわかりやすくなっています。
def hello
puts "Hello World!"
end
言語やファイルによっては、インデントが重要な意味を持ち、
「インデントを忘れていたから思うように動かなかった、、、」なんてこともあります。
インデントのルールはプロジェクトなどによって異なるので、最初に確認して、レビュー前に、そのルールに則っているかしっかり確認しましょう！
タイポと同様に、エディタの設定で、保存時に勝手にインデントを直してくれたり、選択範囲をインデントしてくれるショートカットキーがあったりするので、それらを活用していくのがおすすめです。
3、使われていないコードがないか確認する
プログラムを書いていると、
- リファクタリングして、使われなくなったコード
- それに伴って、必要なくなったインポートの宣言
- レビューには必要ない自分のために残したコメント
などなど、使われていないコードが発生することがあります。
それをそのままにしてしまうと、後々、コードが無駄に肥大化する原因になったり、レビューの際、「これは何に使うんだ？？？」と読み手を混乱させてしまいます。
なので、使わなくなった時点で削除するのが根本的な解決手段ではありますが、それでも見落とす可能性があるので、レビュー前に改めて、自分で確認しましょう。
これも、エディタが警告してくれたりする様々なツールがあるので、活用してみてください。
４、変数、関数名が分かりやすいか確認する
変数名や関数名はその機能や目的を明確に示すべきです。
適切な命名をしていると、コードレビューの時に
「この関数はこんな処理をするんだろうな〜」と読む側の負担も減らせます。
具体的な命名の考え方などはここでは書きませんが、レビュー前に今一度、
🤔「この関数名は関数の内容をわかりやすく表しているかな」と、振り返ってみましょう！
まとめ
この記事で書いた内容はプログラミングスキルが低くても、できることです。
コードレビューも時間を割いてするものです。ケアレスミスや基本的な問題に時間を取られることなく、より高度なアーキテクチャやロジックの議論に集中できるようにしましょう。
確認しても、抜けが発生してしまうのはしょうがないです。ChatGPTなどを活用して、上記のポイントとコードを投げて、機械的に確認してもらうのも有効です。