大写缩写的命名规范

Question

一个返回XML流的方法应该被称为什么？

public Stream getXmlStream();

或者使用以下方法

public Stream getXMLStream();

你对此有什么看法？什么被认为是最佳实践？

- user321068

Answer 1

没有一个正确的答案。这个 维基 的摘录很有用:

编程标识符通常需要包含首字母缩略词和缩写，它们已经是大写字母，例如 "old HTML file"。按照标题大小写规则的类比，自然的驼峰式渲染应该把缩略词全部大写，即 "oldHTMLFile"。然而，当两个首字母缩略词连在一起时（例如，“parse DBM XML”将变为“parseDBMXML”），或者当标准规定使用小写驼峰式但名称以缩略词开头时（例如，“SQL server” 将变成 “sQLServer”）使用此方法会出现问题。因此，一些程序员更喜欢将首字母缩略词视为小写单词并编写“oldHtmlFile”，“parseDbmXml”或“sqlServer”。

- codaddict

Answer 2

一个 "Convention(约定)" 只是这样 - 它不是一条 "Rule(规则)"。然而，我强烈认为 getXmlStream() 是最佳选项。考虑多个这样的术语: 比较 getSQLDBIOXML() 和 getSqlDbIoXml()。

- Bohemian

Answer 3

你应该选择 getXmlStream。想想那些使代码难以阅读的parseDBMXML或更复杂的例子。

来自维基百科驼峰命名法

- Udo Held

Answer 4

我不是说它应该是这样的，但对于一些人来说，当有一串大写字母后跟小写字母时，他们可以自动调整/期望其中有一个缩写词。我的意见是使用getXmlStream() --相比那些能够轻松阅读getXMLStream()的人数，我认为这更容易让大多数人阅读。

- Nonym

Answer 5

建议使用public Stream getXMLStream();

最好保留缩写的原意。

- dku.rajkumar