CamelCase 中的首字母缩略词 [关闭]

Question

我对 CamelCase 有疑问。假设你有这个缩写：Unesco = United Nations Educational, Scientific and Cultural Organization.

你应该写：unitedNationsEducationalScientificAndCulturalOrganization

但是如果您需要编写首字母缩写词怎么办？比如：

getUnescoProperties();

这样写对吗？ getUnescoProperties() 或 getUNESCOProperties();

Answer 1

从接受的答案中有对Microsoft advice 的合理批评。

• 根据字符数对首字母缩写词/首字母缩写词的处理不一致：
  • playerID vs playerId vs playerIdentifier。
• 如果出现在标识符开头的两个字母首字母缩写词是否仍应大写的问题：
  • USTaxes 与 usTaxes
• 难以区分多个首字母缩略词：
  • 即USID vs usId（或parseDBMXML 在维基百科的例子中）。

因此，我将发布此答案作为已接受答案的替代方法。所有首字母缩略词都应一致处理；首字母缩略词应与任何其他词一样对待。 Quoting Wikipedia:

...一些程序员喜欢将缩写词视为小写单词...

所以回复：OP的问题，我同意接受的答案；这是正确的：getUnescoProperties()

但我想我会在这些例子中得出不同的结论：

• US Taxes → usTaxes
• Player ID → playerId

如果您认为应该将两个字母的首字母缩写词与其他首字母缩写词一样对待，请投票支持此答案。

Camel Case 是一种约定，而不是规范。所以我猜流行的意见规则。

（编辑：删除这个投票应该决定这个问题的建议；正如@Brian David 所说；Stack Overflow 不是“人气竞赛”，这个问题被关闭为“基于意见”）

尽管许多人喜欢将首字母缩略词视为任何其他词，但更常见的做法可能是将首字母缩略词全部大写（即使这会导致“可憎”）

• 见XML schema中的“EDXML”
• 请参阅此XBRL schema 中的“SFAS158”

其他资源：

• 请注意，有些人会区分缩写词和首字母缩略词
• 注意 Microsoft 指南区分两个字符的首字母缩写词和“长度超过两个字符的首字母缩写词”
• 请注意，有些人建议完全避免使用缩写词/首字母缩略词
• 请注意，有些人建议完全避免使用 CamelCase / PascalCase
• 请注意，有些人将“一致性”区分为“内部不一致的规则”（即处理两个字符的首字母缩写词与三字符的首字母缩写词不同）；有些人将“一致性”定义为“始终如一地应用相同的规则”（即使规则内部不一致）
• Framework Design Guidelines
• Microsoft Guidelines

Answer 2

免责声明：英语不是我的母语。但是这个问题我想了很久，尤其是在使用node（驼峰式）处理数据库时，因为表字段的名称应该是蛇形的，这是我的想法：

程序员有两种“首字母缩写词”：

• 自然语言，联合国教科文组织
• 在计算机编程语言中，例如tmc and textMessageContainer，通常显示为局部变量。

在编程世界中，自然语言中的所有首字母缩写词都应该被视为单词，原因是：

1. 当我们编程时，我们应该以首字母缩写形式或非首字母缩写形式命名一个变量。因此，如果我们将函数命名为 getUNESCOProperties，则意味着 UNESCO 是首字母缩略词（否则不应全部为大写字母），但显然 get 和 properties 不是首字母缩略词。所以，我们应该命名这个函数 gunescop 或 getUnitedNationsEducationalScientificAndCulturalOrganizationProperties，两者都是不可接受的。

2. 自然语言在不断发展，并且 today's acronyms will become words tommorow，但是程序应该独立于这种趋势并且永远存在。

顺便说一句，在投票最多的答案中，IO 是计算机语言含义中的首字母缩写词（代表 InputOutput），但我不喜欢这个名字，因为我认为首字母缩写词（计算机语言中的）应该只是用于命名一个局部变量，但是一个顶级的类/函数，所以应该使用 InputOutput 而不是 IO

Answer 3

除了@valex 所说的，我想用给定的答案来回顾一下这个问题。

我认为一般的答案是：这取决于您使用的编程语言。

升C

Microsoft has written 一些指导方针，似乎HtmlButton 是为这种情况命名类的正确方法。

Javascript

Javascript 有一些带有首字母缩略词的全局变量，并且它们都以大写形式使用（但有趣的是，并不总是一致）这里有一些示例：

encodeURIComponent XMLHttpRequest toJSON toISOString

Answer 4

JavaScript Airbnb 风格指南talks a bit about this。基本上：

// bad
const HttpRequests = [ req ];

// good
const httpRequests = [ req ];

// also good
const HTTPRequests = [ req ];

因为我通常在课堂上阅读前导大写字母，所以我倾向于避免这种情况。归根结底，这都是偏好。

Answer 5

getUnescoProperties() 应该是最好的解决方案...

如果可能，请使用纯 camelCase，如果您有首字母缩写词，请尽可能将其大写，否则请使用 camelCase。

一般在 OO 编程中，变量应以小写字母 (lowerCamelCase) 开头，类应以大写字母 (UpperCamelCase) 开头。

如果有疑问，就去纯粹的camelCase ;)

parseXML 可以，parseXml 也是camelCase

XMLHTTPRequest 应该是 XmlHttpRequest 或 xmlHttpRequest 没有办法使用后续的大写首字母缩写词，对于所有测试用例来说肯定都不清楚。

例如 你怎么读这个词HTTPSSLRequest，HTTP + SSL，或HTTPS + SL（这并不意味着......），在这种情况下遵循骆驼大小写约定并去httpSslRequest或httpsSlRequest，也许已经不好看了，但肯定更清晰了。

Answer 6

在 github 上有 airbnb JavaScript Style Guide 有很多星星（目前约为 57.5k）和关于 acronyms 的指南说：

首字母缩写词和首字母缩写词应始终全部大写，或全部大写 小写。

为什么？名称是为了便于阅读，而不是为了安抚计算机算法。

// bad
import SmsContainer from './containers/SmsContainer';

// bad
const HttpRequests = [
  // ...
];

// good
import SMSContainer from './containers/SMSContainer';

// good
const HTTPRequests = [
  // ...
];

// also good
const httpRequests = [
  // ...
];

// best
import TextMessageContainer from './containers/TextMessageContainer';

// best
const requests = [
  // ...
];

Answer 7

要转换成CamelCase，还有Google's (nearly) deterministic Camel case algorithm：

以姓名的散文形式开头：

1. 将短语转换为纯 ASCII 并删除所有撇号。 例如，“Müller 算法”可能会变成“Muellers 算法”。
2. 把这个结果分成单词，在 空格和任何剩余的标点符号（通常是连字符）。
   1. 推荐：如果任何单词已经有常规的驼峰格 外观常用，将其拆分为其组成部分 （例如，“AdWords”变成“广告词”）。请注意，这样的词 因为“iOS”本身并不是真正的骆驼案例；它无视任何 约定，因此此建议不适用。
3. 现在全部小写（包括首字母缩写词），然后只大写 第一个字符：
   1. …每个单词，产生上 驼峰式，或
   2. …除第一个单词外的每个单词，以产生 小驼峰式
4. 最后把所有的词加入 单个标识符。

请注意，原始单词的大小写几乎完全是 无视。

在以下示例中，“XML HTTP 请求”正确转换为 XmlHttpRequest，XMLHTTPRequest 不正确。

Answer 8

目前我正在使用以下规则：

1. 首字母大写：XMLHTTPRequest、xmlHTTPRequest、requestIPAddress。

2. 驼峰式缩写：ID[entifier]、Exe[cutable]、App[lication]。

ID 是个例外，对不起，但确实如此。

当我看到一个大写字母时，我假设一个首字母缩略词，即每个字母都有一个单独的词。每个字母的缩写没有单独的单词，所以我使用驼峰式。

XMLHTTPRequest 是模棱两可的，但它是一种罕见的情况，并没有那么模棱两可，所以没关系，规则和逻辑比美观更重要。

Answer 9

UNESCO 是一个特例，因为它通常（在英语中）被解读为一个单词而不是首字母缩略词 - 像 UEFA、RADA、BAFTA 和 BBC、HTML、SSL 不同

Answer 10

还有另一种驼峰式约定，它试图通过使用大写字母 (HTML) 或小写字母 (html) 来提高首字母缩写词的可读性，但避免同时使用两者 (Html)。

所以在你的情况下你可以写getUNESCOProperties。您也可以为变量写unescoProperties，或为类写UNESCOProperties（类的约定是以大写开头）。

如果您想将两个首字母缩略词放在一起，例如对于名为 XML HTTP Request 的类，此规则会变得很棘手。它会以大写开头，但由于 XMLHTTPRequest 不容易阅读（它是 XMLH TTP 请求吗？），而 XMLhttpRequest 会打破驼峰式约定（它是 XM Lhttp 请求吗？），最好的选择是混合大小写：XMLHttpRequest，实际上就是W3C used。但是，不鼓励使用这种命名。对于此示例，HTTPRequest 将是一个更好的名称。

由于标识/身份的官方英文单词似乎是 ID，虽然不是首字母缩略词，但您可以在那里应用相同的规则。

这个约定似乎很流行，但它只是一个约定，没有对错之分。只需尝试遵守约定并确保您的名字可读。

Answer 11

一些guidelines微软写过关于camelCase是：

使用首字母缩略词时，对于长度超过两个字符的首字母缩略词，请使用 Pascal 大小写或驼峰大小写。例如，使用HtmlButton 或htmlButton。但是，您应该将仅包含两个字符的首字母缩略词大写，例如 System.IO 而不是 System.Io。

不要在标识符或参数名称中使用缩写。如果您必须使用缩写，请对包含两个以上字符的缩写使用驼峰式大小写，即使这与单词的标准缩写相矛盾。

总结：

• 当您使用两个字符长的缩写或首字母缩略词时，请将它们全部大写；

• 当首字母缩写词超过两个字符时，第一个字符使用大写。

因此，在您的具体情况下，getUnescoProperties() 是正确的。