レベル: 初級 Scott W. Ambler (scott_ambler@ca.ibm.com), Practice Leader, Agile Development, Rational Methods Group, IBM
2000年 7月 01日 Scott Ambler によるこの最初のヒントでは、仕事をやりやすくするために、各種の Java エレメントを命名するためのガイドラインがいくつか示されています。
変数、フィールド、またはクラスを正確に記述する完全記述子を使用します。
たとえば、firstName、grandTotal、CorporateCustomer などの名前を使用します。x1、y1、fn などは、短いので入力は簡単ですが、それらが何を表しているのか手掛かりがないので、理解や、保守、拡張が困難なコードができ上がってしまいます。
該当する分野に適用できる用語を使用します
エンド・ユーザーがクライアントをカスタマーと呼んでいる場合は、そのクラスに 「クライアント (Client)」という用語ではなく、「カスタマー (Customer)」という用語を使用してください。完璧にふさわしい用語が業界や分野にすでに定着しているのに、多くのデベロッパーが、それらの概念に対して汎用的な用語を使ってしまうという間違いを犯しています。
大文字小文字混合を使用して名前を読み取りやすくします
一般的には小文字を使用すべきですが、クラス名とインターフェース名の先頭文字は大文字にし、またノン・イニシャル・ワードの先頭文字も大文字にします。
省略語は、控え目に、またよく考えて使用します
つまり、短縮形 (省略語) のリストをつくり、それらを賢く選択し、一貫性をもって使用する必要があります。たとえば、number という語の短縮形を使用したい場合は、nbr、no、num などの中から 1 つを選び (どれでもかまいません) 、選んだ短縮形を文書化し、その省略形だけを使うようにします。
長い名前は避けます (15 文字以内にするのをお勧めします)
PhysicalOrVirtualProductOrService というクラス名は、作ったときはぴったりのクラス名のように思えたかもしれませんが (もちろん、この例では、わざと長くしています)、この名前では長すぎるので、Offering のようなもっと短い名前への変更を検討する必要があります。
あまり似通った名前や、大文字小文字が違うだけの名前は避けます
変数名persistentObject とpersistentObjects は、一緒に使うべきではありません。anSqlDatabase とanSQLDatabase にも同じことが言えます。
標準頭字語の先頭文字は大文字にします
名前には、しばしば標準的な省略語が含まれます (たとえば、Standard Query Language に対する SQL)。属性についてのsqlDatabase、あるいはクラスについてのSqlDatabase といった名前は、sQLDatabase やSQLDatabase などよりも読みやすくなります。
参考文献
命名規則と適切なコーディングの仕方について詳しくは、以下の資料を参照してください。
著者について
記事の評価
| 
