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

リーダブルコード:2~3章 理解しやすい名前を付ける

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

上記書籍をまとめと自分の考えを記載します。

 

理解しやすい名前を付けるための注意点

明確な単語を選ぶ。

例えば、getではなく、状況に応じてfetchやdownloadなどを使いましょう。

tmpやretvalなど汎用的な名前を避ける。

for文のイテレータも汎用的な名前(iなど)を避けましょう。

具体的な名前を使って、物事を詳細に説明する。

serverCanStart()よりもCanListenOnPort()の方が明確です。

変数名に大事な情報を付加する。

例えば、単位の情報を付加します。ミリ秒なら、_msなど。

名前の長さはスコープの大きさで決める。

スコープが数画面にも及び大きな変数に1,2文字の名前をつけてはいけないが、スコープが数行であれば短い名前でもよいでしょう。

名前のフォーマットで情報を伝える。

例えば、クラスのメンバ変数にアンダースコアを付けて、ローカル変数と区別用にします。

プロジェクト固有の省略形は避ける。

新しくプロジェクトに参加した人にとっては暗号でしかないので避けましょう。

プログラマの期待に合わせる。

プログラマはgetで始まるメソッドは値を返すだけの「軽量アクセッサ」であるという規約に慣れ親しんでいます。

ブール値の変数名

頭にis/has/can/shouldなどを付けることが多いです。

また、本書には「名前を否定形にするのは避けたほうがいい。」とありますが、否定形の方が理解しやすいケースも多いのではないかと思います。