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

今回もたみぼうずが書いたコードをレビューして悪いところを指摘してあげましょう。

今回のコードは以下です。

const details = getTransportDetails()
const orders = getOrders()
const totalPrice = calcBill(orders)
const latestDetails = details.latest

動作は問題ないようです。ここで、関数が何をやっているのかは分からなくても問題ありません。

ただ、コードを分かりにくくしていることがあります。

関係するコードは並べると分かりやすくなる

実は、関係するコードが並んでいないために読みづらくなっています。

順を追うと以下のようになっています。

一行目、何かの詳細を取得していることがわかります。

二行目、注文の情報を取得しているようです。

三行目、取得した注文情報から合計金額を計算しているようです。

四行目、何かの詳細(一行目)の最新を取得しています。

大きく分けると、一行目と四行目が何かの詳細に関連する処理で、二行目と三行目が注文に関する処理です。

このように、間に他の処理が入ってしまっていることが混乱を招いています。

以下のようにすると、関係する処理がまとまって可読性が上がります。

const details = getTransportDetails()
const latestDetails = details.latest

const orders = getOrders()
const totalPrice = calcBill(orders)

まとめ

関連する処理はできるだけ並べて書く。