【问题标题】:C# attributes naming conventionC# 属性命名约定
【发布时间】:2015-11-21 12:17:32
【问题描述】:

C# 中的属性应使用带有“属性”后缀的 PascalCase 命名,如 here。我的问题涉及更微妙的事情;自然语言中的属性应该如何命名?

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

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

这对我来说很容易理解,但这是一个很长的名字,我对此表示怀疑。 Microsoft 通常提供默认属性的短名称,但它们不是很同质。 Serializable 属性表示装饰类可以序列化。 ObsoleteAttribute 属性表示装饰类具有某种状态。描述和类别属性定义元数据。

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

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

【问题讨论】:

  • [OnlyVisibleForAuthorized] 在我看来会更好。这听起来更像是一个陈述,属性是关于什么的,而你的名字听起来像一个函数。
  • 似乎ModulePermissions 是一个更通用的名称,以后可以添加其他属性。 IsLoggedUserAuthorizedToSeeModule 是特定的,如果该属性将来需要支持其他选项,可能需要更改。
  • 用户是Logged 到文件还是Logged On 在会话中?
  • 我会使用命令式命名它:[ExposeModuleToAuthenticatedUser] 或 [ExposeModuleToLoggedUser]
  • @MarkJansen 好点,谢谢。

标签: c# .net custom-attributes


【解决方案1】:

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

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

无论如何,如何命名你的属性是主观的。对我来说可能有意义的事情,对你来说可能会令人不安。

关于你的具体属性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
{
    ...
}

【讨论】:

  • 而不是AllowedModule,也许只是Module,因为“允许”部分已经由您的场景中的其他属性(授权)处理。
  • @SamAxe 嗯,Authorize 的意思是*你需要获得安全授权*。这就是维护Allowed 作为属性一部分的原因。您可以登录并授权,但不允许使用某些模块
  • 恐怕你是对的,这是主观的。当涉及到登录用户和模块的拆分时,我不需要检查用户是否登录,它在其他地方完成。
  • @Landeeyo 你不需要在那里检查“登录用户”。属性是描述性的。 Authorize + Allowed module = "你必须登录并且我允许你这个模块"
  • @Landeeyo 想想数据注释。你想象一个属性“MinLengthAndNotEmptyAttribute”吗?不,应该有两个属性,MinLength 和 NotEmpty
猜你喜欢
  • 2012-12-03
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2020-06-23
  • 2016-08-31
相关资源
最近更新 更多