20分チャレンジ リーダブルコード 第二章 「名前に情報を詰め込む」

本を要約するパート２です。

今回もリーダブルコードを要約します！

前回に引き続き第二章です。20分チャレンジです！

誰もが変数名から必要な情報を読み取れるような名前付けが理想的だ。

良い名前付けをする方法をいくつか説明していく。

変数名には抽象的ではなく、具体的に想像できる名前をつける。

例えばsizeの名前は一見わかりやすそうだが、そのsizeが何の大きさ・長さ・量を指しているかわからない。

startと似た使い方ができる単語だけでも、begin・launch・open・createなどある。

変数の使い方によって明確な単語を使い分けれるようになろう。

tmp・fooなどの意味のない言葉を名前に選ばないようにしよう。

ただし、一時的な情報の保管ですぐに上書きしてしまう場合にはいいだろう。

時間やバイト数など値があるものには「変数名＋値」とすると、よりわかりやすいだろう。

例えば、start_msやsize_mb

こうすることで、より名前に明確な情報が持たされる。

長すぎる名前は覚えにくいし、コードが折り返されると理解しにくい。

長すぎる名前は良くないが、短すぎると情報が詰め込めない。

どうすれば良いか？

変数のスコープが小さければ、短くて情報が少なくてもいいだろう。

スコープが小さいということは、近くに変数名があるので確認しやすい。

自分で考えた名前の省略形は使わない方が良い。

しかし、string・documentなどはstr・docと略してもわかるだろう。

公式ドキュメントや技術書で省略されている名前に関しては省略しても良いだろう。

プロジェクトメンバーや会社などでコードの書き方を統一して一貫性をもたせることも大切だ。

変数名を見ただけで必要な情報が取得でき、コードがより読みやすくなるように名前を付けよう。

最後まで読んでいただき、ありがとうございます。

今回は時間配分が上手くできなくて、後半が駆け足になってしまった。

初めにページ数と時間を考慮して時間配分を決め、時間内に理解しやすい要約ができるようにしていこう。

最後まで読んでいただき、ありがとうございました。