読者です 読者をやめる 読者になる 読者になる

by shigemk2

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

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

読書ノート

前回
リーダブルコード 1 - by shigemk2

  • 明確な単語を選ぶ
    • Getみたいな「どうとでも取れる」意味を有する単語は使わない
  • tmpやretvalなど汎用的な名前を避ける
    • ただしtmpについては生存期間が短くて「一時的な保管が最も大切な変数」にだけ使う
  • 具体的な名前を遣って物事を詳細に説明する
  • 変数名に大切な情報を追加する
    • ミリ秒を表す変数なら_msを、これからエスケープが必要ならraw_といったふうに。
  • スコープの大きな変数には長い名前をつける
    • 短い名前はスコープが数行の変数につけるべきである
    • 長い名前を何度も入力するのがしんどいとか言う人はエディタの補完機能を使ってよ
    • 汎用的に略されてるもの以外は勝手に言葉を略して使わないこと(evalとか、strとかは意味通じるけど、内輪でしか通じない略し方は避けること)
    • でも無用に長い単語は避け、無駄な単語を切り捨てる勇気を身につけたらよい
  • 大文字やアンダースコアに意味を含める
    • クラスのメンバ変数にアンダースコアをつけて、ローカル変数と区別する