【发布时间】: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