驼背的缩写

我们使用像JAVA和.NET DO这样的CAMEL案例约定。不是因为代码生成器,而是为了可读性。考虑在一个名称中组合两个首字母缩略词的情况,例如将XML转换为HTML的类。

XMLHTMLConverter

或

XmlHtmlConverter

你喜欢哪一个?

原因有二:

1. 更容易区分一个首字母缩略词的结尾和另一个首字母缩略词的标识符,例如在 XmlHtmlConverter .现在,XML和HTML并不是很好的例子,因为每个人都知道什么是XML,什么是HTML。但有时你会看到不太明显的缩写词,然后这就变得很重要了。
2. Eclipse在单词及其首字母方面很聪明。为了 XML HTML转换器 ,您可以输入 XHC 在“打开类型”对话框中,它会找到它。对于一个 XMLHTMLConverter ,首字母应该是 XMLHTMLC 当然要长一点。

我发现XML阅读器更难阅读。原因是你不容易分辨出这些词是在哪里分开的。我相信小写字母缩写应该被接受。您可以将大写字母用于类定义,但是实例变量如何:

XmlReader xmlReader;

无论如何,这里你必须用小写。

对于缩写词,我使用以下规则:

• 如果首字母缩略词的长度为2,则将首字母缩略词放在大写。

    For Ex : UIRule
  

• 如果首字母缩略词的长度更长,我将使用pascal大小写作为首字母缩略词。

    For Ex : SmsValidation, XmlReader
  

.NET框架中使用了Pascal大小写。所以

XmlReader

在Microsoft环境中首选。

我必须同意阿伦瓦纳的说法,这是更容易阅读的替代方案。

参考文献: Microsoft Design Guidelines for Class Library Developers

我相信,一般来说,类名应该按照你期望的方式来书写。例如,当大声说出类名时,我会说“x-m-l reader”,因此我会将类命名为“x m l reader”。然而,我将一个假设的“r e s t服务”类命名为“r e s t service”,因为一般来说,“r e s t”不是发音为“r-e-s-t”,而是“r e s t”。对于“SQL”,我可以选择任何一种方式,因为有些人说“S-Q-L”,而另一些人说“续集”。但这实际上取决于个人喜好。