プログラミング入門 コードレビューの練習をしよう

2020年7月17日

エンジニアになると他の人が書いたコードをレビューすることが多々あります。

いつもこうすれば絶対に間違いない、という書き方はありませんが、ある程度チェックするポイントは決まっているので、今のうちに覚えておきましょう。

コードレビュー

以下はたみぼうずが書いたコードです。あなたはコードレビューを依頼されました。

const calcPoint = point => {
  return point + (point * 0.05)
}

どうやらポイントを算出する処理を書いてくれたようです。

処理内容自体は仕様に沿っているので問題ないようですが、気になるところがあります。

マジックナンバーは使わない

このコードをみて0.05という数値が具体的になんなのか明確ではありません。

このように、コードにいきなり現れる具体的な数値をマジックナンバーといいます。

今回のコードはシンプルなので、なんとなくこれが何かはわかりますが、コード量が増えたり複雑な処理になるほど、マジックナンバーが何を指すのか分からなくなり、理解するのに時間がかかります。

このような場合は、名前をつけるといいでしょう。

const calcPoint = point => {
  const pointRate = 0.05
  return point + (point * pointRate)
}

コード量は増えましたが、これで何をしているか明確になりました。

必ずしも短いコードが良いわけではないので、読み手にとって親切な書き方を心がけましょう。