缩写在骆驼后面
我经常看到Java类的名字
XmlReader
代替
XMLReader
我的直觉是完全大写缩写,但显然很多人的想法不同。 或者,也许只是因为很多代码生成器在缩写词方面遇到了问题。
所以我想听听舆论。 你如何利用包含首字母缩略词的类名来大写?
我们使用像Java和.NET这样的骆驼事件约定。 不是代码生成器的原因,但为了可读性。 考虑将两个缩略词合并成一个名称的情况,例如将XML转换为HTML的类。
XMLHTMLConverter
要么
XmlHtmlConverter
你更倾向哪个?
两个原因:
- 例如在
XmlHtmlConverter
,区分一个缩写词和另一个缩写词的标识符是比较XmlHtmlConverter
。 现在XML和HTML不是很好的例子,因为每个人都知道XML是什么,HTML是什么。 但有时你会看到不太明显的缩略词,然后这变得重要。 - Eclipse用词和首字母缩写是聪明的。 对于
XmlHtmlConverter
,您可以在“打开types”对话框中键入XHC
,并find它。 对于一个XMLHTMLConverter
,首字母缩写应该是XMLHTMLC
,这当然会更长一些。
我发现XMLReader更难读。 原因是你不能轻易地分辨单词分离的地方。 我相信小写的缩写应该被接受。 你可能能够使用大写的类定义,但是什么是实例variables:
XmlReader xmlReader;
无论如何,你必须使用小写字母。
对于首字母缩略词,我使用以下规则:
-
如果首字母缩写词的长度为2,则以大写字母缩写。
For Ex : UIRule
-
如果首字母缩写词的长度更长,那么我使用帕斯卡语的首字母缩写词
For Ex : SmsValidation, XmlReader
Pascal Case在.NET框架中使用。 所以
XmlReader
在Microsoft环境中是首选。
我不得不同意AronVanAmmers这个更容易阅读的select。
参考: Microsoft图书馆开发人员的Microsoftdevise指南
我相信,一般来说,类名应该按照你期望的那样写出来。 例如,当大声说出类名时,我会说“XML阅读器”,所以我将其命名为“XMLReader”类。 但是,我会命名一个假设的“REST服务”类“RestService”,因为一般来说,“REST”不会发音为“REST”,而是“rest”。 对于像“SQL”这样的东西,我可以用任何一种方式去做,因为有些人说“SQL”,有些则说“续集”。 但是,这只是归结为个人偏好。