by shigemk2

当面は技術的なことしか書かない

2012-08-05から1日間の記事一覧

リーダブルコード 6 コメントは正確で簡潔に

前回 リーダブルコード 5 コメントすべきことを知る - by shigemk2 代名詞は避ける 関数の動作は出来るだけ簡潔に正確に説明する // このファイルに含まれる行数を返す function countlines($filename) { .. } でも行数って何のことなのか、いまいちよく分か…

リーダブルコード 5 コメントすべきことを知る

前回 リーダブルコード 4 美しさ - by shigemk2 コメントすべきでないこと コードからすぐ抽出できること(「ここはコンストラクタ」とか、組み込みメソッドの意味とか) ひどいコードを補う「補助的なコメント」 記録すべき自分の考え なぜコードが他のやりか…

リーダブルコード 4 美しさ

前回 リーダブルコード 3 誤解されない名前 - by shigemk2 複数のコードブロックで同じようなことをしていたら、シルエットも同じようなものにする コードの列を整列すれば、概要が把握しやすくなる(align-regexp) ある場所でABCと並んでいたものを外の場所…

リーダブルコード 3 誤解されない名前

前回 リーダブルコード 2 名前に情報を詰め込む - by shigemk2最善の名前とは、誤解されない名前である。つまり、自分のコードを読んでいる人が自分の意図を 正しく誤解なく理解できるということ。というわりには、英単語はlengthとかlimitとか曖昧な意味を…

リーダブルコード 2 名前に情報を詰め込む

前回 リーダブルコード 1 - by shigemk2 明確な単語を選ぶ Getみたいな「どうとでも取れる」意味を有する単語は使わない tmpやretvalなど汎用的な名前を避ける ただしtmpについては生存期間が短くて「一時的な保管が最も大切な変数」にだけ使う 具体的な名前…

リーダブルコード 1

短いコードよりも、理解するまでにかかる時間が短いコードを書く。理解するまでに時間がかからないコードは、処理の最適化、テストしやすいコードなどと競合しないそして、「他人」に読みやすいコードを目指す。ここでいう他人とは、「未来の自分」も含まれ…