带有首字母缩略词的 Java 命名约定 [已关闭]

2022-08-31 05:31:28

以下 Java 类的正确名称是什么:或 ?DVDPlayerDvdPlayer


答案 1

由于看起来答案是Java中没有单一的标准,因此我想指出.NET Framework设计指南确实指定了这一点。

现在,在抨击我偏离主题之前,请记住,Java和.NET Framework的类命名指南非常相似,这使得.NET指南可以作为有说服力的参考。

一般规则

这两项准则都建议仅在首字母缩略词广为人知和理解时才使用首字母缩略词。DVD或XML就是这方面的很好的例子,因为虽然你会立即认出它们,但要认出扩展的版本需要更长的时间。

缩写

.NET Framework 指南建议不要使用缩写(而不是首字母缩略词),除非在标识符中使用两个常用的缩写。使用缩写时,始终使用混合大小写,但驼峰大小写标识符的第一个单词除外(与 Pascal 大小写标识符相反)。IDOKId

在Java中,这种约定只在某些时候被遵循。看看拼写和JCL中的混合程度。(向下滚动该页面的一半)。然而,在Java 8版本中,它被越来越多地使用,这暗示了PascalCase约定现在是首选。如果可能的话,最好完全避免使用缩写。getIDgetIdgetId

缩略语

.NET Framework 指南说,两个字母的首字母缩略词(如 )对于这两个字母应该具有相同的大小写。因此,对于 PascalCase 标识符(如类名),您将获得 ,而对于驼峰大小写标识符(如局部变量),您可能拥有 。IODBRateioChannel

这似乎也是Java中流行的约定。

长缩略语

.NET Framework 指南建议,三个字母或更长的首字母缩略词对 PascalCase 和 camelCase 标识符使用混合大小写,但驼峰大小写标识符的第一个单词除外。因此,对于类名,您可能具有 ,而局部变量可能被命名为 。XmlDocumenthttpRequest

在 Java 中并不总是遵循此约定。四个字符的首字母缩略词似乎确实通常使用混合大小写,但即使是JCL在三个字母的首字母缩略词上也不一致。它们中的大多数似乎都是大写的,如 、、、和 ,但有一些例外,如 。URLXMLSQLDOMJar

结论

对于 Java:

对于 4 个以上字母的首字母缩略词,请使用混合大小写。标准库就是这样做的,这很有意义。

对于 3 个字母的首字母缩略词,您可以使用全大写字母(如 JCL),也可以使用混合大小写(如 .NET Framework)。无论哪种方式,都要保持一致。

对于 2 个字母的首字母缩略词,请使用全大写。

对于2个字母的缩写,Java并没有真正的标准,但我建议使用混合大小写,除非与其他名称的一致性会使所有大写字母看起来更好。


答案 2

没有“正确”的答案。只是一组实践和惯例,可以更好地与您的其他工具配合使用。

因此,我更喜欢.它更有用,因为在Eclipse中,你可以做++,并按每个单词的第一个字母选择类。DvdPlayerCtrlShiftT

alt text