スペルに自信のない変数名・関数名は辞書をひこう、てかひいて!

これから一週間、のんびりお休みなころすけ(@wg_koro)です。こんばんは。

変数名入力

コードを書く時、メソッド名や変数名は大概英語で書きますよね。この英語、たまに間違ったスペルで書かれていることがあります。

自信がなければ辞書をひこう

プロダクトを一人で作っていて、他の人が読むことはない。運用保守全部俺がやるぜ!…というようなシステムならともかく、他の人が一度でも目を通す可能性のあるものは辞書をひきましょう。

何故かって?メンテナンスに時間がかかる&バグを生むからです。

探せない

例えば、「毎日のアクション(このネーミングもどうかと思うが)」を英語にすると「daily_action」ですね。じゃあこれを「deily_action」と書いたとしましょう。ぱっと見、違いが分からないですね。

この部分の処理を追う時、普通は「daily_action」で検索しようとします。

当たり前ですが、当然検索結果に出てこない

あれ?うん?えーー何で???と、無駄に探す羽目になります。こんな時間の使い方は「無駄」以外何者でもないですね。そして探した結果、へにゃへにゃと脱力するわけですが。

書けない

その誤字メソッドがシステムのいたるところで使用されていて、工数的にもはや修正が不可能な場合。泣く泣くそれを使い続けるハメになります。

書きます。「daily_action」と。

動かない。繰り返しますが、これ動かない。「deily_action」と書かないと動かない。

当然、また時間を無駄にするわけです。

100害あって1利無し

これまで書いてきたように、誤字のメリットは何もないです。「悪」でしかないです。最近は辞書ツールやオンライン辞書が充実しているので、自信のない単語はきちんと辞書をひきましょう。

参考程度に自分がよく使う辞書を紹介しておきます。英辞郎とweblioです。これらはChrome拡張があるので、Webサイトへ移動しなくてもすぐに辞書をひけます。便利!

拡張機能はこんな感じ。※各画像はクリックで拡大できます
weblio拡張

英辞郎拡張

余談ですが、今回書いた内容(探せないで凹む・動かなくてヘコむ)は全部体験済みですorz。自分もTypo(誤字)は気をつけよう…。

2013.12.11追記 ===
このような場合の解決方法を書いてみました。

政治的な理由で直せないTypoした変数名・メソッド名を解決する方法 | Azrael

コメントを残す

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください