大写缩写的命名约定[关闭]

Posted

技术标签:

【中文标题】大写缩写的命名约定[关闭]【英文标题】:Naming convention for upper case abbreviations [closed] 【发布时间】:2012-01-06 19:41:58 【问题描述】:

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

public Stream getXmlStream();

或者改为

public Stream getXMLStream();

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

【问题讨论】:

【参考方案1】:

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

编程标识符通常需要包含首字母缩写词和首字母缩写词 已经是大写的,例如“旧 html 文件”。类推 使用标题大小写规则,自然驼峰式渲染将具有 全部大写的缩写,即“oldHTMLFile”。然而, 当两个首字母缩写词一起出现时(例如, “parse DBM XML”会变成“parseDBMXML”)或者当标准 要求小写驼峰式,但名称以缩写开头 (例如,“SQL 服务器”将变为“SQLServer”)。为此,一些 程序员更喜欢将缩写视为小写 单词并写“oldHtmlFile”、“parseDbmXml”或“sqlServer”。

【讨论】:

【参考方案2】:

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

【讨论】:

【参考方案3】:

您可能应该选择getXmlStream。想想parseDBMXML 或更复杂的例子,使代码无法阅读。

来自***CamelCase

【讨论】:

【参考方案4】:

我不是这样说should,但对于某些人来说,他们可以自动调整/预期当大写字母后跟小写字母的连续字符串时,某处会有一个首字母缩略词。我的 opinion 是与 getXmlStream() 一起使用的——与立即能够阅读 getXMLStream() 的人数相比,我的 think 对大多数人来说更容易阅读放轻松。。

【讨论】:

【参考方案5】:

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

【讨论】:

以上是关于大写缩写的命名约定[关闭]的主要内容,如果未能解决你的问题,请参考以下文章

google-命名约定

编程的命名法

google风格C/C++编程规范 --- 命名约定

google风格C/C++编程规范 --- 命名约定

智一科技 约定 mysql

仅在彼此直接相邻的大写字母之间插入空格[关闭]