代码之家 › 专栏 › 技术社区 › bitbonk

Resharper抱怨成员“EntityID”中的大写“ID”

framework-design resharper naming-conventions c#

24

bitbonk · 技术社区 · 15 年前

我在一个类中有一个属性“entityid”。Resharper(5.1)说

名称“entityid”与规则不匹配 “方法、属性和事件”。建议的名称为“EntityID”。

但依我的命名约定 Design Guidelines for Class Library Developers . 'EntityID“应该非常好:

不要使用在计算中不被普遍接受的缩写词。字段。

在适当的情况下,使用众所周知的首字母缩略词替换冗长的短语。名字。例如,使用用户界面联机接口和联机分析处理分析处理。

当使用首字母缩略词时,使用pascal case或camel case作为首字母缩略词两个字符长。例如,使用 HTMLButton或HTMLButton。然而,你应该大写首字母缩写只包含两个字符,例如作为System.IO而不是System.IO。

不要在标识符或参数名称中使用缩写。如果你必须使用缩写,使用驼色大小写包含更多的缩写超过两个字符,即使这个与标准缩写相矛盾这个词

*更新:* 最新版本的指南还指出:

将两个字符的首字母缩略词的两个字符都大写,除了驼色大小写标识符的第一个字。 名为dbrate的属性是使用的缩写词(db)的一个示例作为帕斯卡的第一个词标识符。一个名为 iochannel是一个简短的例子首字母缩略词(IO)用作驼色大小写的标识符。

我是否正确理解指南?如果是这样,我如何使resharper接受“entityid”(众所周知的两个字母缩写)而拒绝“htmlreader”(应该是htmlreader)。

4 回复 | 直到 15 年前

1

21

LukeH 15 年前

您是要遵循框架设计指南的建议,还是要使用大写字母? ID 无论如何?

这个 latest version of the guidelines 必须这样说:

可以使用的两个缩写在标识符中 身份证件 和 OK . 在 pascal cased标识符表现为 Id 和 Ok . 如果用作骆驼壳中的第一个词标识符,它们应显示为 id 和 ok ,分别。

因此,在以下情况下,resharper似乎是正确的 身份证件 .

出于兴趣,Resharper还建议两个字符的首字母缩略词遵循相同的大小写规则。这与指导方针不一致: 请将两个字符的首字母缩略词的两个字符都大写,驼色大小写标识符的第一个字除外。

2

43

Tim Lloyd 15 年前

如果希望Resharper将“ID”作为“Identity”的有效缩写,只需选择属性,按“alt enter”,然后从Resharper上下文菜单中选择“Add‘ID’to the abbreviations list”。

3

8

Dean Harding 15 年前

最简单的解决方案是进入Resharper选项,在“C命名样式”选项卡下,确保选择了“覆盖常用设置”,然后双击“方法、属性和事件”。单击“添加”添加一个新的,并将其设置为“uppercamelcase”,名称后缀为“id”。

根据需要添加其他后缀。

您也可以使用“C命名样式”页面上的“高级设置…”按钮来完成此操作,这会给您带来更多的灵活性,但我不会为此而烦恼…

4

5

Åukasz W. 15 年前

在缩写列表中添加“id”怎么样??