コードを書く際の注意点

自責の念を込めて。
「プログラミング作法(第1章）」を読んでいて胸が痛くなった箇所を書き留めていく。

スタイル

変数

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

演算子

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

コメント

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

だらしないコードは悪いコード。
単に読みづらいだけでなく、問題を抱えているケースが多い。