2011-06-21 15 views
6

クラスをファイルに分割するときに、enumのみを含むクラスファイルの命名規則が何であるか疑問に思っています。他のクラスと同じように、列挙型の名前と一致する必要がありますか?または、列挙型のみが含まれていることをデベロッパーが知るように 'Enum'を付ける必要がありますか?例えばEnumクラスのファイル名の後に 'Enum'を付ける必要がありますか?

namespace MyCompanyName.MyApplication 
{ 
    public enum Colors 
    { 
     Red, 
     Blue, 
     Green, 
     Yellow 
    } 
} 

は上記のコードを含むファイルが 'Colors.cs' または 'ColorsEnum.cs' という名前する必要がありますと思いますか?あるいは、おそらく、そのようなファイルのための別の受け入れられた命名規則がありますか?

+0

号Colors.Orangeが有効でない理由は、誰も理解できないだろう。 ColorsEnumを呼び出すことは役に立ちません。しかし、そのすべてがIntelliSenseによって分類されます。あなたはそれが使用されていると考えるかもしれません。 –

答えて

5

まず、完全な個人的/チームの優先事項です。

私は個人的にそれをColors.cs名前を付けます:言われていること

。これにより、型名に対応するファイル名が保持されます。私がAPIに取り組んでいるときに、「色」が列挙型で表される固定セットのものであれば、おそらくそれが分かり、混乱はありません。

2

Enumsという名前のフォルダを作成し、Colors.csファイルに名前を付けるのはどうですか?

+0

私はこれに同意します。ファイルに単一のオブジェクト宣言しか含まれていない場合、ファイル名がオブジェクトと同じであると便利です。 – Derrick

7

私の意見のファイル名は、Enum Naming guidelinesによると、ではなく、にEnumサフィックスがあるはずです。また、ガイドラインは、あなたの列挙型は、列挙型と呼ばれるフォルダを作成特異ので取って、両方のアカウントにそれがあるべきColor.cs

1

する必要があります示唆して、列挙型または記述何かが十分でなければなりません。 また、あなたが言ったC#の命名基準に従うことができます。

「を列挙 の名前列挙値名に接頭辞を使用しないでくださいをたとえば、ADOの列挙型の広告、またはリッチのためのRTFとして接頭辞を使用していませんテキスト列挙など。

これはまた、あなたが列挙値の名前に列挙型の名前を含めるべきではないことを意味します。次のコード例で間違って列挙の値を命名示しています。

C#のコードを

を次のように
public enum Teams 
{ 
    TeamsAlpha, 
    TeamsBeta, 
    TeamsDelta 
} 

参考文献:あなたは最悪の例を選んだ Names of Classes, Structs, and Interfaces

+0

私は、型名に接頭辞や接尾辞が含まれてはならないことを認識していますが、この質問は特にファイル名を参照して質問しています。 –

+0

あなたは他人のコンテンツをコピーして、このように再配布することはできません。それが「著作権X、すべての著作権」となります。 Stack Exchangeに投稿することにより、投稿コンテンツを[CC BY-SA](http://creativecommons.org/licenses/by-sa/3.0/)ライセンスに基づいて配布する権利があることを宣言します。あなた自身の言葉で答えを書いてください(そして、詳細については、外部のサイトにリンクしてください)。 – Gilles

関連する問題