【リーダブルコード】２章のまとめ

２章

名前に情報を詰め込む

をまとめていきます。

- - - １章はこちら

<li>
  <a href="#i-2">解りやすい名前を付けよう</a><ul>
    <li>
      <a href="#i-3">「解りやすい名前を付けよう」</a>
    </li>
  </ul>
</li>

<li>
  <a href="#i-4">【メソッド名】</a>
</li>
<li>
  <a href="#i-5">【変数名】</a>
</li>
<li>
  <a href="#i-6">まとめ</a>
</li>

１章はこちら

解りやすい名前を付けよう

２章は、いますぐに改善できる！

「解りやすい名前を付けよう」

が主軸の内容になります。

以下、表面上の改善が説明されています。

・メソッド名

・変数名

コード一行一行に関係ある内容なので、

意識することで、大きな改善になるよ！と書いてあります。

塵も積もれば山となるですね。

【メソッド名】

抽象的に書きすぎないこと。

よく使いがちな、

・GetHoge

上記のような名前が本当に正しいのか、一考する必要がある。

Getの類義語には、

FetchやDownloadなどがある。

使う状況や対象にあった単語を付けましょう。

名前は、長くても良い。

IDEやテキストエディタには、

入力補助・単語保管機能があるので、

名前が長くても間違えたりはしない。

【変数名】

単位があるものは、単位を付けよう。

・hoge_ms

中身の属性がバグの原因になりうる変数は、

属性を書きましょう。

・hoge_unescaped

・hoge_utf8

ループイテレータも解りやすくしよう。

特に、複数ループの場合はイテレータを複数使用せず

同じイテレータを使用する。

for(int hoge_i = 0; ……….){

for(int hogehoge_i = 0; ……….){

for(int hogehogehoge_i = 0; ……….){

汎用的な名前を使うのは控えよう。

tmpとかretとかですね。

一行しか使用しないような変数の場合は、

使っても問題ないです。

まとめ

名前に情報を詰め込むことで、

「解りやすい名前を作ろう」

と言った内容でした。

その為にもコーディング規約を作成することや

標準的なコーディング規約は知識として、

蓄えている必要がありますね。

htmlであれば、

idはアンダーバを使い、

classはハイフンを使うなど。

例：id=hoge_hoge　class=hoge-hoge

３章のまとめ「誤解されない名前」。

リンク