程序里有很多东西需要命名,
- 良好的命名习惯可以提高编程效率; 减少出错;
- 良好命名的程序清晰易读。
- 好的名称可以提供很多有价值的信息。
本文讨论在工程实践中广泛使用的对象命名规则。
1. 小驼峰命名法则
小驼峰命名法(Lower Camel Case)是一种常见的编程命名规范,主要用于变量、函数或方法名的命名。其规则如下:
首字母小写:名称的第一个单词全部小写开头。
后续单词首字母大写:从第二个单词开始,每个单词的首字母大写,其余字母小写。
- 无分隔符:单词之间不使用下划线(_)或连字符(-)等分隔符。
变量名 | 含义 |
---|---|
priceStock | 股票价格 |
airQuailityIndex | 空气质量指数 |
personCount | 人数 |
quantityComponents | 元件数量 |
counter | 计数器 |
函数/方法名 | 含义 |
---|---|
setPrice() | 设置价格 |
getQuantity() | 获取数量 |
pushPedal() | 踩脚踏板 |
add() | 添加元素 |
drawGrid() | 绘制表格 |
相较于其他命令规则,小驼峰命名法有以下优点:
- 提高可读性(相比全大写或无分隔命名)
- 避免命名中的空格问题(编程语言通常不支持空格)
- 广泛被多种编程语言社区采用
2. 大驼峰命名法则
大驼峰命名法(Upper Camel Case,又称 Pascal Case)是一种编程和代码书写中的命名规范,其核心特点是:
每个单词的首字母均大写,包括名称的第一个单词。
单词之间无分隔符(如空格、下划线 _ 或连字符 -)。
- 其余字母小写(除非是专有名词或缩写,如 XMLParser)。
实践中,类型/接口名称(以及构造函数名称),常使用大驼峰命名。
类型名称 | 含义 |
---|---|
User | 用户类型 |
Int64 | 64位有符号整数类型 |
ColorSpace | 颜色空间 |
DataProcessor | 数据处理器 |
HttpClient | HTTP客户端 |
3. 蛇形命名法
有的编程语言,比如Python,会偏爱在变量、函数命名时采用蛇形命名法(snake case)。其核心规则是:
- 全小写字母:所有字母均使用小写(如 user_name,而非 User_Name)。
- 下划线 _ 分隔单词:单词之间用下划线连接,不能使用空格或连字符(如 first_name,而非 firstName 或 first-name)。
- 允许数字:可在单词后加数字(如 user_id_123)。
- 不推荐连续下划线:避免 user__name 这样的写法(通常无意义且影响可读性)。
名称 | 含义 |
---|---|
user_name | 用户名称 |
validate_user_input() | 检查用户输入 |
student_age | 学生年龄 |
create_account() | 创建账号 |
log_path | 日志存储路径 |
4. 例外
如果有一个临时变量,仅在上下几行局部代码中被使用,用完即弃,可以用小写单字母:(代码阅读者容易通过上下文确定变量的类型和用途)
1 | for (i in 0..10) { //循环变量i用单字母 |