自定义属性的命名约定和准则

Question

如果属性的名称应该是单数还是复数，是否有任何约定（可能是 Microsoft）？

我不确定命名约定是什么或是否有任何约定？我想要我系统中角色的属性我不确定是否按照惯例（如果有）我应该将其复数为RolesAttribute 或保持单数RoleAttribute。

- 编辑-

现在我认为自定义属性仍然是派生自 Attribute 基类的类，那么类的约定也适用于 C# 属性吗？

Answer 1

这实际上取决于您要实现的功能。简而言之，如果您使用属性分配一个角色，请保持单数，如果您分配多个角色，则使用复数。

在更一般的术语中，Attributes 应使用清晰的 pascal cased 名称命名，其功能是将元数据或声明性信息与代码相关联。与代码中的其他所有内容一样，请确保它们具有描述性且明确。

我喜欢遵循的一些好的准则如下：

• Avoid unsealed attributes
• Custom attributes should end with the suffix Attribute
• 定义具有参数的构造函数来初始化与所需参数相对应的属性
• 每个构造函数参数都应与对应的属性具有相同的名称（casing除外）
• Define accessors for attribute parameters, usually settable properties for optional parameters and getter only for required parameters
• Mark attributes with the AttributeUsageAttribute