リファクタリング

[shimodatkh]

コメント

• 使っていないコード>削除すべき。
• 説明
  • whyを説明
  • 正しい＞残すべき
  • 誤っている>直すか、消すべき
  • why以外の単なる解説
  • コードと矛盾>訂正か消すべき
  • 難しいコードをわかりやすく説明＞放置
  • 明らかにわかること＞消すべき？

http://qiita.com/kosei/items/b1b6c34db87b93819cce

コメント

・当たり前のことをいちいち書くな ・コードと矛盾させるな →ほとんどのコメントはそれが書かれた時点ではコードと一致しているが、 バグが直されたりプログラムが進化してもコメントがほったらかしにされるケースが多い。 コードを変更したら、コメントがまだ正確かどうかきちんと確認するように！！！！ コメントはコードのなぜを説明するものであり、コードが何をしているかを説明するものではない

[shimodatkh]

http://qiita.com/kosei/items/b1b6c34db87b93819cce

変数

変数名や関数名は、オブジェクトのラベルである。 その目的についての情報を伝えるので簡潔で覚えやすい名前をつけるべき。 【基本】 グローバル変数にはわかりやすい名前。 ローカルには短い名前。 マジックナンバーには名前を付けよう 演算子

・（）を使って曖昧さを回避しよう if( blockId>=3 || blockId<=8 ) if( (blockId>=3) || (blockId<=8) ) ※演算子には優先順位があるので、意図しない結果にならないために明示的に（）で括ろう