Flash CS3 ドキュメンテーション

ActionScript 2.0 の学習 > ActionScript 2.0 のベストプラクティスとコーディング規則 > 命名規則 > クラスとオブジェクトの命名

クラスとオブジェクトの命名

新しいクラスファイルを作成する場合、クラスと ActionScript ファイルの命名には次のガイドラインを使用します。適切な形式で命名したクラス名の例を示します。

class Widget;
class PlasticWidget;
class StreamingVideo;

クラスには、パブリックメンバー変数とプライベートメンバー変数を設定できます。クラスには、ユーザーから直接に設定およびアクセスされることが望ましくない変数も含むことができます。そのような変数はプライベートにして、getter/setter メソッドを使用しないとアクセスできないようにします。

クラスの命名には、次のガイドラインが適用されます。

• クラス名は大文字で始めます。
• 単語を複合または連結してクラス名を作成する場合は、大文字と小文字を混在させます。 

  単語を複合または連結したクラス名は、大文字で始めます。たとえば、NewMember のような名前にします。

• クラス名には通常、名詞または修飾語を伴う名詞を使用します。 

  修飾語とは、その名詞やフレーズに説明を加える言葉です。たとえば、"member" という名詞に修飾語を付けると、NewMember や OldMember のようになります。

• 名前を短くすることよりも、わかりやすくすることを重視します。
• 頭字語や略語を使用しないようにします。 

  ただし、頭字語や略語で表すことが一般的になっている用語 (HTML や CFM など) の場合は例外です。よく使用される頭字語の場合は、NewHTMLParser ではなく NewHtmlParser のように先頭の大文字以外は小文字にすると読みやすくなります。

• クラスの内容を説明する、意味のわかる簡潔な名前を使用します。

  あいまいであったり、誤解を招かないように、一般的な名前を使用してください。

• クラス名は複合語である場合もあります。

  修飾語とは、その名詞やフレーズに説明を加える言葉です。たとえば、"member" という名詞に修飾語を付けると、NewMember や OldMember のようになります。

• クラス名で使用する単語は複数形にしないようにします (Witches、BaldPirates など)。

  多くの場合、単に修飾語を伴う名詞にするのが適切です。修飾語とは、その名詞やフレーズに説明を加える言葉です。たとえば、"cat" や "buckaneer" という名詞に修飾語を付けると、BlackCat や OldBuckaneer のようになります。

• 冗長になるので、クラスのプロパティ名にはクラス名を含めないようにします。 

  たとえば、Cat.catWhiskers は意味がありません。Cat.whiskers の方が適切です。

• 動詞としても解釈できる名詞は使用しないようにします。 

  たとえば、Running や Gardening などです。このような名詞を使用すると、メソッド、状態、またはアプリケーションの他の動作と混同する可能性があります。

• 1 つのアプリケーション内では、各クラスに一意のクラス名を使用します。
• クラス名は、Flash のビルトインクラスの名前と競合しないようにします。
• できれば、階層構造内におけるそのクラスの関係を示すクラス名にします。 

  これによって、アプリケーション内におけるクラスの関係がわかりやすくなります。たとえば、Widget というインターフェイスがある場合、Widget を実装するクラスには PlasticWidget、SteelWidget、および SmallWidget のような名前を付けます。

インターフェイスの詳細については、インターフェイス.を参照してください。

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flash/9.0_jp/main/00001098.html

コメントの追加