読みやすいコードのために気をつけていることは何ですか｜技術面接問題

こう聞かれます

「読みやすいコードのために、気をつけていることは何ですか」
「よい変数名とは、どんな名前ですか」
「コメントには何を書きますか」

面接官が見ている点

「きれいに書く」で止まらず、具体的な工夫を挙げられるか
読むのは自分だけでなく、チームの人や半年後の自分だ、と分かっているか
自分のコードで、実際に直した例を話せるか

短い答え

変数や関数には、中身や役目が名前だけで分かる言葉を付けます。
関数は 1 つの仕事に絞り、条件に合わないときは先に return して、入れ子を浅くします。
コメントには、コードを読めば分かることではなく、なぜそう書いたかという理由を書きます。

少し詳しい答え

先に返して、入れ子を浅くする

買えない場合を先に調べて返すと、最後まで残った所が「買える」場合だけになります。if の中に if を重ねるより、上から順に読めます。

JavaScript

function canBuy(user, item) {
  if (!user) {
    return "ログインが要ります";
  }
  if (item.stock === 0) {
    return "在庫がありません";
  }
  return "買えます";
}

const me = { name: "Aya" };
const ok = { stock: 3 };
const none = { stock: 0 };
console.log(canBuy(null, ok));
console.log(canBuy(me, none));
console.log(canBuy(me, ok));

ログインが要ります
在庫がありません
買えます

名前で中身を伝える

d や data より、trialDays や cartItems のほうが、何が入っているかがすぐ分かります。true か false を返す関数は canBuy や isValid のように、問いの形にすると読みやすくなります。名前の付け方 (キャメルケースなど) は、チームの決めにそろえます。

コメントには理由を書く

// 1 を足す のように、コードを読めば分かることは書きません。「税込みは端数を切り捨てる決まりのため floor を使う」のように、なぜそう書いたかを残すと、あとで直す人が誤って変えずに済みます。

作った物と結ぶなら、たとえば「ポートフォリオで入れ子が 4 段になっていた入力の確かめを、先に返す形に書き直し、レビューで読みやすくなったと言われました」のように話します。

よくある間違い

「短く書くほど読みやすい」と言う 1 行に詰め込んだ書き方や、1 文字の名前は、かえって読みにくくなります
コードの動きをそのままコメントに書くコードと同じことを書くと、コードを直したときにずれて嘘になります。理由を書きます
自分の好みだけで書き方を決めるチームの決めや、自動で形を整える道具に合わせると、読む人がそろった形で読めます

深掘りの問い

「読みにくいコードを見つけたら、どうしますか」動きを確かめるテストを用意してから、名前の付け直しや関数の切り出しを少しずつ行う、と答えます
「書き方をそろえるために、何か道具を使っていますか」形を自動で整える道具や、書き方の決めを機械で調べる道具を使い、保存や push のたびに回す、と答えます
「読みやすさと速さが、ぶつかったらどうしますか」まず読みやすく書き、測って遅い所が分かったときだけ、理由をコメントに残して速くする、と答えます