リーダブルコード備忘録

概 要

『リーダブルコード』を読んで、個人的に気をつけたいことをまとめました。

コメントを「どのように」書くか？

//属性リストから順に属性を取り出す。
//名前／値のセットを取り出せる。
//そこで出力する。
for (var i = 0, len = attrs.length; i < len; i++) {
    略
};

• 上の例のように、１行で収まるようなコメントをわざわざ複数行に分けない。
• 「そこ」「その」など人によって判断が分かれる曖昧な言葉は使わない。
• 逆に実例を書くときは、「この場合はどうなるんだろう？」といったような人によって答えが変わる複雑なものを例に選ぶ。

複雑になりがちな制御フローをいかに簡潔にするか？

• IF文などにおいて条件式の並び順。(例：IF (君の年齢(調査対象) > 20（比較対象）)のように、IF文の主語とも取れる方を先に書いた方が理解しやすい。)
• IF/ELSE文のブロックの並び順。(人は否定形を理解しづらい。if (!false)よりもif (true)）
• 何重ものネストは分かりづらい。

変数

• 変数を活用する。（例：式を変数に代入）
• 一方で、本当にその変数は作成する必要があるのか？ないなら削除。
• 変数のスコープを縮める。

リーダブルコード