包含缩写的类的命名规范

Question

如果我在面向对象编程的语言中命名一个新类，下面哪种约定更好呢：

1. XMLWriter
   • 最常见的写法
2. XMLwriter
   • 更容易区分
3. XmlWriter
   • 不再是缩写
4. XML_Writer
   • 去掉了驼峰命名法的点

有点学究气，但我很想知道谁使用什么和为什么使用。

- Aram Kocharyan

---

取决于编程语言——不同的编程语言有不同的规则/生态系统。请适当打标签。（一个适当的名称可能非常合适为“xmlwriter”）。 - user166390

选择尽可能接近该语言原生类的选项，并保持一致。 - alex

Answer 1

最近，Java约定似乎更倾向于将知名缩写词视为单词，因此："XmlWriter"...

http://www.ibm.com/developerworks/library/ws-tip-namingconv.html

使用缩写的Java命名约定<-重复问题？

http://geosoft.no/development/javastyle.html

但似乎没有人很一致。以JavaScript的XMLHttpRequest为例，真是一团糟！

- david van brink

Answer 2

我相信各种不同的命名约定的人们会因为我说这话而想要把我绞死。但是在我看来，你应该使用最容易阅读的命名约定。名称只由人类使用，因此它们应该是最容易阅读和理解的。所以对于像XMLWriter这样的东西，我可能会将其写成XmlWriter，因为这似乎更容易阅读。对于非常非常常见的东西（即XML），我认为将其作为一个单词处理最好。如果你有一些特定于你领域的缩写词，则可以将其大写，这样不经常使用它的人就能理解它是一个缩写词。基本上，使名称的真实意图更容易理解，即使这使得阅读略微困难。我认为使用常识和最佳判断比试图遵循一组绝对的命名规则更好。虽然命名应尽量遵循合理的命名约定。

- Zipper

Answer 3

我认为你应该始终选择最易读的方式（正如Zipper所说），并且至少将类名以大写字母开头，因为我在某个地方读到这是Java标准约定，而且我也觉得以大写字母开头总是可以让你确定它是一个Java类。

- amod

---

Java使用XMLReader和XmlReader。它还使用URL和HttpHandler，以及两种风格的HttpURLConnection。因此，您不能在Java API中寻求一致的建议。 - Joachim Sauer