他の人が最短で理解できるコードを書くためにも変数や関数名の命名は重要な要素の一つですよね。
今回は名著リーダブルコードを参考によりわかりやすい名前の付け方についてまとめていきます。
コメントがなくても理解できるコードを目指していきましょう。
具体的な名前をつける
変数や関数名を見て直感的に格納している値や機能が理解できる名前にしましょう。
リーダブルコードではよく見かける「get」「set」なども曖昧な表現なため避けるべきだと述べられています。
以下は本書に挙げられていた例となります。
単語 | 代替案 |
---|---|
send | deliver, dispatch, announse, distribute, route |
find | search, extract, locate, recover |
start | launch, create, begin, open |
make | create, set up, build, generate, compose, add, new |
※その後につける単語が明確であれば、上記の左側の単語を使用しても個人的には問題ないと考えています。基本は日本人に優しい単語を使用したほうがいいかと。
当然ですが以下のような汎用的すぎる変数は避けましょう。
n=1;
flag=false;
変数名に単位などの情報を追加する
数値や日付などを変数に格納する場合は、単位を付加するとわかりやすくなります。
width->width_px
limit->limit_sec
名前の長さ
長すぎる名前はコードが読みづらくなり、省略しすぎると役割が明確でなくなります。
以下に注意して名前の長さを決めましょう。
- スコープが小さければ短い名前でも問題ない
- 名前の省略はString->strなどどのプログラマでも理解できるなら省略しても問題ない。プロジェクトメンバーしか理解できない省略形は避ける
- 不要な単語を省く。ConverToString()はToString()にするなど単語を削除しても役割が明確なら切り捨てる。
自分も良い名前が思いつかず安易な変数名を付けてしまうことがよくあります。
上記を意識して可読性の高いコードになるよう日々心がけていきましょう。
この記事のアイキャッチ画像は以下より文字を自由に買えられます
コメントを残す