属性“ID”的正确命名约定是什么？ : 身份证还是身份证？

Question

非常简单的问题：当我有一个持久对象时，它通常有一个名为 ID 的属性（对于抽象类）。

那么..命名约定是ID还是Id？

例如。

public int ID { get; set; }

或

public int Id { get; set; }

干杯:)

PS。 顺便说一句，这是针对 .NET 的。 FXCop 一致性将是一个额外的好处。

Answer 1

http://en.wiktionary.org/wiki/id#Abbreviation

为什么要对抗它？

Answer 2

我通常使用标识符。 如果我确实想保持简短（例如，作为较长标识符的一部分），我会使用 Id，除非它是参数或私有成员。

.NET Framework 命名指南这样说：

首字母缩略词是由术语或短语中单词的字母组成的单词。 例如，HTML 是超文本标记语言的缩写。 仅当缩写词广为人知且易于理解时，才应在标识符中包含缩写词。 首字母缩写词与缩写词的不同之处在于缩写词会缩短单个单词。 例如，ID是标识符的缩写。 一般来说，库名称不应使用缩写。

可在标识符中使用的两个缩写是 ID 和 OK。 在 Pascal 大小写的标识符中，它们应显示为 Id 和 Ok。 如果用作驼峰式标识符中的第一个单词，它们应分别显示为 id 和 ok。

Answer 3

无论你喜欢什么，只要保持一致即可。 ID不是一个单词，而是身份的缩写。 如何写缩写是人们争论了很长时间的一个问题。 例如，它

getResourceURL

或

getResourceUrl

实际上两者都可以在不同的框架中使用。 另一个流行的缩写。 UTF8 也有类似问题。

保持一致很重要，因为否则人们总是必须查找每个方法的正确大小写，如果每个方法都以不同的方式处理它。

我对此有自己的惯例。 如果缩写。 位于名称末尾，全部大写，如果在其他地方，则遵循驼峰表示法规则。 例如

getResourceURL
urlOfResource
compareUrlToString

为什么？ 我喜欢缩写。 要大写。 大多数人希望 URL 或 UTF 是大写的。 但是，如果位于名称中间，则会破坏骆驼表示法的优势。 驼峰表示法的优点是您可以通过大写看到新单词的开头位置。 所以比较一下：

compareURLToString
compareUrlToString

在第一种情况下，我没有立即看到 URL 是一个单词而 To 是下一个单词。 T 可能是 URL (URLT) 的一部分并且是不同的缩写，因此我将使用第二种形式。 然而，如果它在最后，它就不会发挥作用，后面没有其他单词，因此我更喜欢大写形式。 我在所有代码中都遵循这一约定。

Answer 4

指南上写着“Id”。

幸运的是，.Net 的人很友善地为我们提供了“命名指南”而不是“命名法则”;)，所以基本上，如果您强烈认为违反指南规则确实比遵循它增加了更多价值，那么无论如何都要打破它，如果他们理解你的原因（比如它提供了更多的可读性并强调了名字的含义），没有人会追究你的责任。

在我的店里，即使指南说“Id”，我们也使用“ID”，但没有人，真的对此感到内疚。

Answer 5

正如其他人指出的那样，根据 .NET 约定，Id 是正确的，但不知何故感觉不太对，所以很多人使用 ID（并且仍然活着）。

我不知道您的字段的内容是什么（数字、字符串、guid），但如果您想跳过这个问题，您可以简单地使用另一个 .NET 约定作为对象标识符：名称

Answer 6

我们在内部使用 ID，因为 Id 在我看来就像心理学的说法，但 FxCop 抱怨道，因为 ID 不是缩写词，它是缩写（Identity/Identifier）。 根据 FxCop 规则，只有两个字符长的首字母缩略词才允许全部大写。 其他一切都应该是正确的情况。

我们在 ID 属性上添加了 SuppressMessage 属性，每个人都很高兴。

Answer 7

“ID”是 FxCop 命名规则中硬编码的缩写之一，即使它们是其他单词的一部分，也始终被视为拼写错误。 我发现覆盖它的唯一方法是将“ID”添加到缩写词中作为 ()：

<Dictionary>
<Acronyms>
   <CasingExceptions>
        <Acronym>ID</Acronym>
  </CasingExceptions>
</Acronyms>
</Dictionary>

它与 FxCop 1.36 一起使用。
PS 总的来说，我认为“Id”是一个更好的选择，但有时如果名称是基于我们无法控制的 XML 文件（或 Web 服务）生成的，则无法更改名称

Answer 8

我更喜欢 ID，也可以与其他单词（例如 CustomerID）结合使用，但严格来说，这违反了常规命名约定。

Answer 9

我们在这里将“Id”或其他缩写词视为一个单词，“Id”是最简单的一个，因为在银行业务中我们确实会遇到很多奇怪的字母组合。 因此，我们将其视为一个单词，仅将第一个字母大写，这就是我们最终在内部编码约定文件中定义的方式。

但底线是：选择哪种约定对开发团队和其他查看源代码并坚持使用的人来说更舒服。