物业的最佳命名？

Question

您在C#中为属性名称选择以下三个选项中的哪一个,为什么？

1. YearToDateWages
2. YTDWages
3. YtdWages

Answer 1

我会选择1.我不想缩写任何东西,除非它是一个超常用的首字母缩略词,这将是荒谬的拼写.像"HyperTextTransferProtocolRequest"这样的东西拼出来是很荒谬的,因此将它缩写为"HttpRequest"是安全的.这有点主观,但如果有疑问,我倾向于不缩写.

如果您决定选择2或3,我可能会根据"框架设计指南"中的建议投票支持3.它基本上说对于3个或更多字母长的首字母缩略词,你应该把第一个字母大写,小写字母大写其余部分.两个字母的首字母缩略词有点含糊不清...有些人喜欢把所有字母都用作"ID",有些人更喜欢用"Id".该指南实际上是将2个字母的首字母缩略词的所有字母大写,但这种情况与3个以上字母缩写词的指南相矛盾,因此人们都是这样做的.

Answer 2

我会使用YearToDateWages,因为如果不在列表中,我就不会知道你在说什么.

另请参阅MSDN上的一般命名准则:

通常,您不应使用缩写或首字母缩略词.这些使你的名字可读性降低.同样,很难知道什么时候可以安全地假设首字母缩略词被广泛认可.

有关缩写的大小写规则,请参阅大写约定.

不要使用缩写或收缩作为标识符名称的一部分.

例如,使用OnButtonClick而不是OnBtnClick.

不要使用任何未被广泛接受的缩写,只在必要时使用.

重点是原创.