Enum类文件名是否应以“Enum”为后缀?

时间:2011-06-21 23:44:51

标签: c# enums naming-conventions filenames

将类分解为文件时,我想知道只包含枚举的类文件的命名约定是什么。它们是否应该与枚举名称匹配,就像任何其他类一样,或者它们是否应以“Enum”为后缀,以便开发人员知道该文件只包含枚举?

例如:

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

您是否会将包含上述代码的文件命名为“Colors.cs”或“ColorsEnum.cs”?或者,也许这些文件有另一个可接受的命名约定?

5 个答案:

答案 0 :(得分:9)

我认为文件名应该与Enum的名称相同,根据Enum Naming guidelines 的枚举后缀。此指南也建议您的枚举应该是单数,因此考虑到它应该是Color.cs

答案 1 :(得分:5)

首先,这是一个完整的个人/团队偏好。

话虽如此:

我个人会将其命名为Colors.cs。这使文件名对应于类型名称。当我正在使用API​​时,如果“颜色”是由枚举表示的固定事物集合,我可能知道这一点,并且不会产生混淆。

答案 2 :(得分:2)

如何创建名为Enums的文件夹并命名文件Colors.cs?

答案 3 :(得分:1)

创建名为Enumerations,Enums或描述性内容的文件夹就足够了。 您也可以按照C#命名标准说:

“枚举名称 不要在枚举值名称上使用前缀。例如,不要为ADO枚举使用ad作为前缀,或者对富文本枚举使用rtf,等等。

这也意味着您不应在枚举值名称中包含枚举类型名称。以下代码示例演示了错误地命名枚举值。

C#代码如下

public  enum Teams
{
    TeamsAlpha,
    TeamsBeta,
    TeamsDelta
}

参考文献: Names of Classes, Structs, and Interfaces

答案 4 :(得分:0)

这是一个很好的例子,说明了命名空间和文件夹结构如何使您的目录更具可读性。我的公司将枚举类型粘贴在_enumeration文件中,但将其保留在与主要使用这些枚举的类相同的名称空间中。这是一个优先事项,您应该做您和您的队友最容易做的事情。我不会在您的文件夹结构中使用任何匈牙利式表示法。