Help us understand the problem. What is going on with this article?

読書まとめ:リーダブルコード 第2章

More than 5 years have passed since last update.

まとめをしようと思った動機

技術書やコーディングスキル本など色々読んでいるが、しっかりと理解できているのかわからなくなった。
理解できているか確認するために、内容の簡易まとめをする。
今後コーディングを行う際の備忘録として記載する。

第2章 名前に情報をつめこむ

  • 意味が明確な単語を選ぶ
    例えばGetではなく、状況に応じてFetchやDownLoadを使うことで明確になる。

  • tmpやretvalなどの汎用的な名前を避ける
    明確な理由がある場合は使用してもよい。

  • 具体的な名前を使って、物事を詳細に説明する
    例えばServerCanStart()よりもCanListenOnPort()の方が明確になっている。

  • 変数名に大切な情報を詰め込む
    例えばミリ秒を表す変数名は名前の後ろにmsをつける。
    また、これからエスケープが必要な変数名には、前にraw
    をつける等、変数名に大切な情報を付加する。
    ※rawの意味は「生の」という意味。

  • スコープの大きな変数には長い名前を付ける
    スコープが数画面に及ぶ変数に1~2文字の短い暗号めいた名前をつけてはいけない。
    短い名前はスコープが数行の変数につけるべき。

  • 大文字やアンダースコアなどに意味を含める
    例えばクラスのメンバ変数にアンダースコアをつけて、ローカル変数と区別するなど。

所感

コーディングを行う際の指針として使っていきたい。
ただし、言語により命名規則が異なるため、それも考慮する必要がある。

kiyomaru
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away