本文へジャンプ

「送信する」をクリックすることにより、お客様は developerWorks のご使用条件に同意したことになります。 ご使用条件を読む


お客様が developerWorks に初めてサインインすると、プロフィールが作成されます。プロフィールで選択した情報は公開されますが、いつでもその情報を編集できます。お客様の姓名(非表示設定にしていない限り)とディスプレイ・ネームは、投稿するコンテンツと一緒に表示されます。

送信されたすべての情報は安全です。

  • 閉じる [x]

developerWorks に初めてサインインするとプロフィールが作成されますので、その際にディスプレイ・ネームを選択する必要があります。ディスプレイ・ネームは、お客様が developerWorks に投稿するコンテンツと一緒に表示されます。

ディスプレイ・ネームは、3文字から31文字の範囲で指定し、かつ developerWorks コミュニティーでユニークである必要があります。また、プライバシー上の理由でお客様の電子メール・アドレスは使用しないでください。

「送信する」をクリックすることにより、お客様は developerWorks のご使用条件に同意したことになります。 ご使用条件を読む


送信されたすべての情報は安全です。

  • 閉じる [x]

Java 命名規則

より安楽な人生を

Scott W. Ambler, Practice Leader, Agile Development, Rational Methods Group, IBM
Scott W. Ambler は、オブジェクト指向ソフトウェア処理の指導、アーキテクチャー・モデリング、および Enterprise JavaBeans (EJB) 開発を専門とするコンサルタント会社である、Ronin International の社長です。彼は、オブジェクト指向開発に関する本を執筆あるいは共同執筆しています。最近刊行されたものとしては、この記事で要約された主題を詳しく論じた The Object Primer 2nd Edition などがあります。彼の連絡先は www.ambysoft.com にあるサイトです。

概要: Scott Ambler によるこの最初のヒントでは、仕事をやりやすくするために、各種の Java エレメントを命名するためのガイドラインがいくつか示されています。

日付:  2000年 7月 01日
レベル: 初級 この記事の原文:  英語
アクティビティー: 8834 ビュー
お気軽にご意見・ご感想をお寄せください: 


変数、フィールド、またはクラスを正確に記述する完全記述子を使用します。

たとえば、firstNamegrandTotalCorporateCustomer などの名前を使用します。x1y1fn などは、短いので入力は簡単ですが、それらが何を表しているのか手掛かりがないので、理解や、保守、拡張が困難なコードができ上がってしまいます。

該当する分野に適用できる用語を使用します

エンド・ユーザーがクライアントをカスタマーと呼んでいる場合は、そのクラスに 「クライアント (Client)」という用語ではなく、「カスタマー (Customer)」という用語を使用してください。完璧にふさわしい用語が業界や分野にすでに定着しているのに、多くのデベロッパーが、それらの概念に対して汎用的な用語を使ってしまうという間違いを犯しています。

大文字小文字混合を使用して名前を読み取りやすくします

一般的には小文字を使用すべきですが、クラス名とインターフェース名の先頭文字は大文字にし、またノン・イニシャル・ワードの先頭文字も大文字にします。

省略語は、控え目に、またよく考えて使用します

つまり、短縮形 (省略語) のリストをつくり、それらを賢く選択し、一貫性をもって使用する必要があります。たとえば、number という語の短縮形を使用したい場合は、nbrnonum などの中から 1 つを選び (どれでもかまいません) 、選んだ短縮形を文書化し、その省略形だけを使うようにします。

長い名前は避けます (15 文字以内にするのをお勧めします)

PhysicalOrVirtualProductOrService というクラス名は、作ったときはぴったりのクラス名のように思えたかもしれませんが (もちろん、この例では、わざと長くしています)、この名前では長すぎるので、Offering のようなもっと短い名前への変更を検討する必要があります。

あまり似通った名前や、大文字小文字が違うだけの名前は避けます

変数名persistentObjectpersistentObjects は、一緒に使うべきではありません。anSqlDatabaseanSQLDatabase にも同じことが言えます。

標準頭字語の先頭文字は大文字にします

名前には、しばしば標準的な省略語が含まれます (たとえば、Standard Query Language に対する SQL)。属性についてのsqlDatabase、あるいはクラスについてのSqlDatabase といった名前は、sQLDatabaseSQLDatabase などよりも読みやすくなります。


参考文献

命名規則と適切なコーディングの仕方について詳しくは、以下の資料を参照してください。

著者について

Scott W. Ambler は、オブジェクト指向ソフトウェア処理の指導、アーキテクチャー・モデリング、および Enterprise JavaBeans (EJB) 開発を専門とするコンサルタント会社である、Ronin International の社長です。彼は、オブジェクト指向開発に関する本を執筆あるいは共同執筆しています。最近刊行されたものとしては、この記事で要約された主題を詳しく論じた The Object Primer 2nd Edition などがあります。彼の連絡先は www.ambysoft.com にあるサイトです。

不正使用の報告のヘルプ

不正使用の報告

ありがとうございます。 このエントリーは、モデレーターの注目フラグが設定されました。


不正使用の報告のヘルプ

不正使用の報告

不正使用の報告の送信に失敗しました。


developerWorks: サイン・イン


IBM ID が必要ですか?
IBM IDをお忘れですか?


パスワードをお忘れですか?
パスワードの変更

「送信する」をクリックすることにより、お客様は developerWorks のご使用条件に同意したことになります。 利用条件

 


お客様が developerWorks に初めてサインインすると、プロフィールが作成されます。 プロフィールで選択した情報は公開されますが、いつでもその情報を編集できます。 お客様の姓名(非表示設定にしていない限り)とディスプレイ・ネームは、投稿するコンテンツと一緒に表示されます。

表示名をお選びください

developerWorks に初めてサインインするとプロフィールが作成されますので、その際にディスプレイ・ネームを選択する必要があります。ディスプレイ・ネームは、お客様が developerWorks に投稿するコンテンツと一緒に表示されます。

ディスプレイ・ネームは、3文字から31文字の範囲で指定し、かつ developerWorks コミュニティーでユニークである必要があります。また、プライバシー上の理由でお客様の電子メール・アドレスは使用しないでください。

(半角英数字で3文字以上31文字以下にする必要があります)


「送信する」をクリックすることにより、お客様は developerWorks のご使用条件に同意したことになります。 利用条件

 


この記事を評価する

コメント

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=60
Zone=SOA and web services
ArticleID=244767
ArticleTitle=Java 命名規則
publish-date=07012000

タグ

Help
このタグで、My developerWorks のすべてのタイプのコンテンツを見つけるために検索フィールドを使用します。

スライダーバーを使用することで、より多く(少なく)タグを表示します。

人気のタグは、この特定のコンテンツ・ゾーン(例えば、Java テクノロジー、Linux や WebSphere など)に対するトップのタグを表示します。

マイ・タグは、この特定のコンテンツ・ゾーン(例えば、Java テクノロジー、Linux や WebSphere など)に対するお客様ご自身のタグを表示します。

このタグで、My developerWorks のすべてのタイプのコンテンツを見つけるために検索フィールドを使用します。人気のタグは、この特定のコンテンツ・ゾーン(例えば、Java テクノロジー、Linux や WebSphere など)に対するトップのタグを表示します。マイ・タグは、この特定のコンテンツ・ゾーン(例えば、Java テクノロジー、Linux や WebSphere など)に対するお客様ご自身のタグを表示します。