常见命名规范

0. 前言

使用好的命名规范能够让自己和他人更加容易阅读和理解代码。

1. 常见命名方式

1.1. 驼峰命名法

驼峰命名法指的是使用大小写混合的格式，单词之间不使用空格隔开或者连接字符连接的
命名方式。它有两种格式：大驼峰命名法（UpperCamelCase）和小驼峰命名法
（lowerCamelCase）。

# 大驼峰命名法的第一个单词以大写字母开始，其余的和小驼峰命名法相同
LastName, InputStream。

# 小驼峰命名法的第一个单词以小写字母开始，其他单词以大写字母开始，其余字母使用小
写字母。
firstName, toString

1.2. 蛇形命名法

在蛇形命名法中，单词之间通过下划线“_”连接，比如“out_of_range”。

1.3. 串式命名法

在蛇形命名法中，单词之间通过连字符“-”连接，比如“background-color”。

1.4. 匈牙利命名法

在匈牙利命名法中，标识符由一个或者多个小写字母开始，这些字母用来标识标识符的类
型或者用途。标识符的剩余部分，可以采取其他形式的命名法，比如大驼峰命名法。

如果起始的小字母用来表示标识符的数据类型，这种命名法也被称为系统匈牙利命名法。
比如：

lAccountNum 标识一个 _ 长整数 _（首字母“l”，long）。
szName 标识一个 _ 零字符结束的字符串 _（首字母“sz”，zero-terminated string）。

如果起始的小字母用来表示标识符的实际用途，这种命名法也被称为应用匈牙利命名法。
比如：

rwPosition 标识一个 _ 行 _（首字母“rw”，row）。
usName 标识一个 _ 非安全字符串 _（首字母“us”, unsafe string）。

由于在微软产品中的广泛使用，匈牙利命名法曾经是一种流行的命名形式。然而，由于这
种命名会带来不必要的记忆负担和阅读障碍，导致命名规则的执行和名称的维护都很困
难，微软已经抛弃了这种命名形式。

2. 取好名字

了解命名方法后，如何取好名字尼？只需要遵循如下三条原则。

2.1. 要有准确的意义

名字要能够准确、完整地表达出它代表的含义，可以见字知意，名副其实。

比如：a = x - y 语法上没什么问题，但是表达式代表的含义并不清楚。相比而言：“grossIncome = grossRevene - costOfGoodsSold”就有很准确、清晰的现实意义。这样的命名更容易阅读和理解。

2.2. 严格遵守命名规范

不同的编程语言，会使用不同的命名规范，比如Go语言倾向于使用”驼峰命名法”、Python 倾向于使用 “蛇形命名法”。如果定义了个性的命名规范，则严格遵守自定义的命名规范，否则我们就需要遵守业界普遍工人的命名规范。

2.3. 可读性优先

名字的可读性要优先考虑，一般需要注意以下几点：

1）可读性强的名字优先于简短的名字，尽量使用完整词汇
2）不要使用缩写、简写、缩略词，除非这些词语被广泛使用
3）不要使用太短的名字，比如一个字母，除非是广泛接受的特例（i/j/k/m/n 表示临时使用的整数，c/d/e 表示临时使用的字符
4）避免含糊、混淆或者误导。

另外，不要混合使用英文和汉语拼音。由于很多类库使用的是英文，如果使用汉语拼音命名，会造成事实上的拼音名字与英文名字的混用，所以也要尽量避免使用拼音命名。