A A リーダブルコード - user000422/0 GitHub Wiki

原則

とにかく読み手の立場になること。 優れたコードは理解しやすいコードである。 簡潔に1行にまとめて書いたコードは必ずしも優れているとはいえない。

名称

■省略形について 誰でも理解可能な省略形は使用して良い。(document = doc)

■限界値を含める時は「min」と「max」を使う。 例)MAX_ITEMS_IN_CART

整列

改行やスペースを使って美しく整列させましょう。 とにかく読みやすいコードが正義です。 コメント、メソッド、引数を整列。

$sample_red  = sample('red',  100); // コメントも整列
$sample_blue = sample('blue', 10);  // コメントも整列

コメント

コメントの目的は、書き手の意図を読み手に伝えること。 書き手の考えやメモを記述しても良い。例)このメソッドは汚くなってきている。 TODOも使用していこう。 事情があって定石とは異なるコードには必ずコメントを残しておきましょう。

if

条件は否定形ではなく肯定形を使うこと。 単純な条件を優先して書くこと。 簡潔で可読性の高いコードになる場合のみ参考演算子を使用する。基本的にif/elseにしなさい。

if (color = red) {
  //
} else if (color != blue) {
  //
} else {
  //
}

その他

ネストは浅くすること。 早期returnは正義。 グローバル変数は絶対禁止。どこでどのように使われるか把握できない。名前空間が汚れる。