开发者命名约定指南

如何命名变量、函数和文件看似是个人喜好问题，实则是一条影响团队生产力和代码可读性的规则。

为什么命名约定很重要

代码被阅读的次数远多于被编写的次数。一致的命名约定能帮助他人（以及未来的你）快速理解代码。

当规则统一时，仅凭名称就能提示某个东西是变量、常量还是类，从而减少无谓的查找。

主要格式一览

• camelCase —— 首个单词小写，之后每个单词的首字母大写（myVariableName）
• PascalCase —— 每个单词的首字母都大写（MyClassName）
• snake_case —— 全部小写，单词以下划线连接（my_variable_name）
• CONSTANT_CASE —— 全部大写并以下划线连接，通常用于常量（MAX_COUNT）
• kebab-case —— 全部小写并以连字符连接，通常用于 URL 和 CSS（my-class-name）

按语言和场景的约定

许多语言都推荐各自的约定。Python 的变量和函数偏好 snake_case，JavaScript 和 Java 使用 camelCase，而大多数语言的类名都使用 PascalCase。

无论使用哪种语言，常量通常都写成 CONSTANT_CASE，而 kebab-case 实际上已成为 URL 路径和 CSS 类名的标准。

一致性比规则本身更重要

没有哪一种格式是绝对正确的。最重要的是始终如一地遵循你的项目或团队所约定的规则。

当你加入一个已有的代码库时，应优先遵循它的约定，而非个人喜好。如果需要一次性重命名许多标识符，大小写转换器会很有帮助。