小编典典

带有首字母缩略词的 Java 命名约定

all

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


阅读 111

收藏
2022-05-20

共1个答案

小编典典

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

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

一般规则

两个指南都建议仅在首字母缩略词广为人知且易于理解时才使用首字母缩略词。DVD 或 XML
就是很好的例子,虽然您会立即识别它们,但识别扩展版本需要更长的时间。

缩写

.NET Framework
指南建议不要使用缩写词(与首字母缩写词相反),除了两个常见的缩写词ID并且OK可以在标识符中使用。使用缩写时,Id始终使用混合大小写,除了
camelCase 标识符的第一个单词(与 PascalCase 标识符相反)。

在 Java
中,这个约定只在某些时候被遵循。看看拼写getIDgetId在 JCL 中的混合程度。(向下滚动该页面的中途)。不过,在Java 8
版本
getId中,它被越来越多地使用,这表明 PascalCase 约定现在是首选。最好尽可能完全避免缩写。

缩写词

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

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

长首字母缩略词

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

Java 中并不总是遵循此约定。四个字符的首字母缩写词似乎通常使用大小写混合,但即使是 JCL
也对三个字母的首字母缩写词不一致。它们中的大多数似乎都是大写的,例如URL, XML, SQL, and
DOM,但也有一些例外,例如Jar.

结论

对于 Java:

对于 4 个以上字母的首字母缩写词,请使用大小写混合。标准库做到了这一点,这很有意义。

对于 3 个字母的首字母缩写词,您可以像 JCL 一样使用全部大写,也可以像 .NET Framework 那样使用混合大小写。无论哪种方式,保持一致。

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

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

2022-05-20