C# 属性命名约定

Question

C# 中的属性应使用带有“Attribute”后缀的 PascalCase 命名，如所写 here .我的问题是关于更微妙的事情；自然语言中的属性应该如何命名？

例如 - 我在 ASP MVC 应用程序中有一个授权属性，它检查登录的用户是否有权查看模块(由特定 Controller 表示)。我决定将其命名如下:

[IsLoggedUserAuthorizedToSeeModule(ModuleName = ModuleManager.Modules.ExampleModule)]
public class ExampleModuleController : BaseController
{
    ...
}

对我来说还算可以理解，但是名字太长了，我有疑惑。 Microsoft 通常提供默认属性的简称，但它们不是很相似。 Serializable 属性表示装饰类可以序列化。 ObsoleteAttribute 属性意味着装饰类有一些状态。描述和类别属性定义元数据。

可以找到默认 .NET 属性的完整列表 here .

是否有关于属性命名约定的指南？你知道关于它的任何文章吗？

Answer 1

属性应使用简短的 pascal 大小写句子命名。

毕竟，它们修饰程序集成员，当您看到应用的属性时，您想通过阅读它们的名称来理解它们的含义。

无论如何，如何命名您的属性是主观的。对我来说可能有意义的事情可能会让你感到不安。

关于您的具体属性 IsLoggedUserAuthorizedToSeeModuleAttribute，也许它可以简化为 AllowedModuleAttribute 并且您应该实现另一个属性 AuthorizeAttribute ( or re-use MVC's one ) :

// This way you splitted out the concept of "logged users" and "what module"
[Authorize, AllowedModule(ModuleManager.Modules.ExampleModule)]
public class ExampleModuleController : BaseController
{
    ...
}