C#命名约定的首字母缩略词
关于C#命名缩略词,如果我正在编写一个与Windows API有关的库,那么对于WindowsApi或WindowsAPI是否有强大的约定,还是仅仅是个人偏好?
有一个约定,它为大于2个字符的所有首字母缩写词指定了首字母大写,其余字母小写。 因此HttpContext
和ClientID
。
Krzysztof Cwalina和Brad Abrams撰写的“ 框架devise指南 ”第二版第40-42页
3.1.2大写首字母缩略词
除了骆驼标识符的第一个字以外,两个字符的首字母缩略词都要大写两个字符。
System.IO public void StartIO(Stream ioStream)
除了骆驼标识符的第一个字以外,只能使用带有三个或更多字符的首字母缩略词的首字母大写。
System.Xml public void ProcessHtmlTag(string htmlTag)
在骆驼式的标识符开始时, 不要使用任何缩写词的任何字符,不论其长度。
检查微软官方命名指南这里命名指南
我听说你应该避免缩写,所以它会成为WindowsApplicationProgrammingInterface
,然后。
更严重的是(人们似乎错误地阅读了上面的内容,尽pipe下面有引用), 这个页面说:
任何三个或更多字母的首字母缩写应该是帕斯卡的情况下,不是所有的上限。
由于API被认为是一个众所周知的首字母缩略词,如果您想遵循指导原则,则可以selectWindowsApi
这个名称。
其个人喜好。 但是.NET会使用WindowsApi
。 这类似于TcpClient
的命名。
这一切都只是个人(或组织)的偏好。 只要你一致,你会没事的。
.NET框架本身会使用WindowsApi。
看看FxCop吧。 这是一个很好的工具,可以帮助解决这个问题。
老问题,新答案。
根据MSDN大写公约条款的“首字母缩略词规则”部分:
除了驼峰标识符的第一个字外,还要将两个字符首字母缩写词的两个字符都大写。
名为
DBRate
的属性是用作Pascal标识符的第一个单词的短首字母缩写词(DB
)的示例。 一个名为ioChannel
的参数是一个简短的首字母缩略词(IO
)的例子,用作骆驼标识符的第一个字。除了驼峰标识符的第一个字外,只能利用带有三个或更多字符的首字母缩略词的首字母大写。
名为
XmlWriter
的类是用作Pascal标识符的第一个单词的长首字母缩写词的示例。 名为htmlReader
的参数是用作骆驼式标识符的第一个词的长首字母缩写词的示例。在骆驼式的标识符开始时,不要使用任何缩略词的任何字符,无论其长度如何。
名为
xmlStream
的参数是用作驼峰标识符的第一个字的长首字母缩写词(xml
)的示例。 名为dbServerName
的参数是用作骆驼标识符的第一个字的短首字母缩略词(db
)的示例。