【问题标题】:Naming Conventions For Class Containing Acronym包含首字母缩写词的类的命名约定
【发布时间】:2011-11-16 15:22:38
【问题描述】:

如果我用 OOP 语言命名一个新类,这是一个更好的约定:

  1. XMLWriter
    • 最常见
  2. XML 编写器
    • 更容易区分
  3. XmlWriter
    • 不再是首字母缩写词
  4. XML_Writer
    • 去除驼峰纹

迂腐是的,但我很好奇谁使用什么以及为什么使用。

【问题讨论】:

  • 取决于语言——不同的语言有不同的规则/生态系统。请适当标记。 (一个合适的名字很可能是xmlwriter。)
  • 选择最接近该语言的原生类并保持一致。

标签: oop class naming-conventions


【解决方案1】:

我会说你应该总是更喜欢最易读的一个(正如 zipper 所说),并且至少以大写字母开头类名,因为我在某处读到它是 Java 标准约定,我也觉得以大写字母开头总是使你确定它是一个 Java 类。

【讨论】:

【解决方案2】:

我很确定所有不同的命名约定人们都会因为我说这些而想把我串起来。但在我看来,您应该使用的命名约定应该是最容易阅读的。名称仅由人类使用,因此它们应该是最容易阅读/理解的名称。所以对于像 XMLWriter 这样的东西,我可能会把它称为 XmlWriter,因为这样看起来更容易阅读。对于非常常见的东西(即 XML),我认为将其视为一个词效果最好。如果您有一些特定于您的域的首字母缩略词,那么我可能会将它大写,以便那些不一直使用它的人会理解它是一个首字母缩略词。基本上可以更容易地理解名称的真实意图,即使它稍微难以阅读。我认为使用常识和最佳判断比试图坚持一套绝对的命名规则要好。虽然命名应该尽量遵循一套合理的命名约定。

【讨论】:

    【解决方案3】:

    Java 约定最近似乎倾向于将众所周知的首字母缩略词视为单词,例如:“XmlWriter”...

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

    Java Naming Convention with Acronyms

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

    但似乎没有人非常一致。以 JavaScript 的 XMLHttpRequest 为例。什么火车失事!

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2014-06-29
      • 2011-01-15
      相关资源
      最近更新 更多