リーダブルコード 第一部 表面上の改善を読んだまとめ。コード書く人は読んだ方が良い。
「優れた」コードの定義
- コードは理解しやすくなければいけない
- コードは他の人が最短時間で理解できるように書かなければ行けない
- 理解のしやすさが正義。この正義を貫くために実践すると良い手法が本にはつらつらと書いてある。
名前に情報を詰め込む
そのためには次のようなことに注意すれば良い
- 明確（カラフル）な単語を選ぶ
- get は明確な単語ではない
- 例：getPage(Url) -> downloadPage(Url) にすればより明確
- スレッド停止処理が重ければ kill()、再開できるなら pause() などカラフルな単語へ
- 汎用的な名前を避ける
- foo bar などエンティティを無視した名前を避ける
- スコープの小さな、一時保管の意味しかもたない変数は tmp でも良い
- 抽象的な名前よりも具体的な名前を使う
- DISALLOW_EVIL_CONSTRUCTORS
- 接尾辞や接頭辞を使って情報を追加する
- 値の単位: size -> size_mbyte
- 重要な属性: comment -> unescaped_comment
- 名前の長さを決める
- スコープが小さければ短い名前でもいい
- 他人が理解できる頭文字は積極的に使う: document -> doc
- 不要な単語を投げ捨てる: ConvertToString() -> ToString()
- 名前のフォーマットで情報を伝える
- フォーマット規約を決め、それに従う: メンバ変数をアンダースコア始まりにするとか
About
ウェブ界隈でエンジニアとして労働活動に励んでいる @gomi_ningen 個人のブログです