大写缩写的命名约定

时间:2011-11-26 08:56:11

标签: java naming-conventions uppercase camelcasing abbreviation

是否应该调用返回XML流的方法

public Stream getXmlStream();

或者

public Stream getXMLStream();

您对此有何看法?什么是最佳实践?

5 个答案:

答案 0 :(得分:35)

没有一个正确的答案。这个wiki摘录很有帮助:

  

编程标识符通常需要包含首字母缩略词和首字母缩写词   已经是大写的,例如“旧的HTML文件”。类推   使用标题案例规则,自然骆驼案例渲染将具有   缩写全部为大写,即“oldHTMLFile”。然而,   当两个首字母缩略词一起出现时,这种方法是有问题的(例如,   “解析DBM XML”将成为“parseDBMXML”)或标准时   强制降低驼峰的情况,但名称以缩写开头   (例如“SQL server”将成为“sQLServer”)。出于这个原因,一些   程序员喜欢将缩写视为小写   单词并写“oldHtmlFile”,“parseDbmXml”或“sqlServer”。

答案 1 :(得分:18)

“惯例”只是 - 它不是“规则”。但是,我强烈认为getXmlStream()是最佳选择。考虑多个这样的术语:将getSQLDBIOXML()getSqlDbIoXml()

进行比较

答案 2 :(得分:13)

你应该去getXmlStream。想想parseDBMXML或更复杂的例子,使代码变得不可读。

来自维基百科CamelCase

答案 3 :(得分:7)

我不是说should是这样的,但是对于一些人来说,他们可以自动调整/期望当有一系列连续的大写字母后跟低位字母时,某处有一个缩写词。我的 opinion getXmlStream()一致 - 我认为think对于大多数人来说更容易阅读,与那些能够立即查看的人相比轻松阅读getXMLStream() ..

答案 4 :(得分:2)

建议使用public Stream getXMLStream(); 最好保留缩写

的原始含义