什么是＆＃34; VPNAPIs＆＃34;的正确命名？类

Question

写一个班级名称的正确方法是什么＆＃34; VPNAPIs＆＃34;？是VpnApis，VPNAPIs还是VpnAPIs？

VPN：虚拟专用网络。
API：应用程序接口。

Answer 1

VpnApis是正确的。

根据java的命名约定，

  

所有类，接口都应该以大写字母开头，然后是   名词/形容词

     

每个Java类名称必须以大写字母开头，如果   出现子词，然后它也由Capital开始。

Answer 2

答案是，这三种选择都是合法的 ¹ ，这取决于您遵循的编码标准以及选择的解释方式。

我的建议

1. 与您的同事交谈。
2. 选择一个样式指南，并同意，确保遵守法规的严格程度。
3. 使用常识。样式指南的目的是最大程度地提高可读性。他们并不是他们自己的目的。

---

原始的1997年Sun Java Code Conventions（不再“维护”）。

  

“类名应该是名词，每个内部单词的第一个字母都用大写字母混合。尝试使类名保持简单和描述性。请使用整个单词-避免使用首字母缩写词和缩写词（除非缩写词使用得更广泛）而不是长格式，例如URL或HTML）。

重要说明：

• 上面的不会表示仅内部单词的第一个单词应为大写。
• 尽管它建议一般不要使用缩写词，但它并不强制要求缩写词 的书写方式。

因此：

• VpnApis遵守
• VPNAPIs符合（啊！）
• VpnAPIs遵守

Java SE类库中使用缩略词的各种类名示例增强了这种解释。其中许多是在1997年以后添加的，其理由是它们是“历史例外”。 （请注意，1997年是JDK 1.1发行的时间！）

---

Google Java Style Guide

  

“以散文形式开头：

     

  
1. 将短语转换为纯ASCII并删除所有撇号。例如，“穆勒算法”可能会变成“穆勒算法”。
  
2. 将此结果划分为单词，在空格和所有剩余的标点符号（通常为连字符）上分割。      
     
   • 推荐：如果某个单词在常规用法中已经具有常规的驼峰式外观，请将其拆分为各个组成部分（例如，“ AdWords”变成“ ad words”）。请注意，诸如“ iOS”之类的词本身并不是驼峰式的。它违反了任何约定，因此该建议不适用。
     
  
3. 现在将所有内容（包括首字母缩写词）都小写，然后仅将以下内容的第一个字符大写：      
     
   • ...每个单词，以产生大写字母大写字母，或
     
   • ...除了第一个单词以外的每个单词，都会产生较小的驼峰大小写
     
  
4. 最后，将所有单词合并为一个标识符。”
  

这给出了：

• VpnApis是正确的
• VPNAPIs不正确
• VpnAPIs不正确

，通过文档中的示例进行了增强。

但是请注意，这些规则显然会指出许多Java SE类名不正确。

---

^{1-对于有价值的东西，我的偏好是1）选择一个不同的类名（这个名称不能清楚地表明类的目的……尽管如果有更多的上下文可能会这样），2）使用VpnApis，3）使用VpnAPIs。}