变量用的好与不好,和代码的质量有着非常重要的联系。
如何为变量起名
- 在编程中起的最多的名字,还数各种的变量。给变量起一个好的名字很重要,因为好的变量命名可以极大的提高代码整体的可读性。
1.变量名具有描述性
- 比如:
- 正确的变量名:
start_time
- 错误的变量名:
time
- 正确的变量名:
2.变量名最好能简单易懂,一下就能猜出类型
- 布尔类型变量最大特点:只存在
是
或不是
。所以用is
和has
词修饰变量名。原则就是让读到变量名的人马上就能判断出这个变量只会有是
或不是
两种。
- 比如:
- 是否删除:
is_delete
- 是否禁用 :
is_enabled
- 有没有错误 :
has_error
- 是否删除:
- 比如:
- 人们看到和数字相关的名字,都会默认他们是
int/float
类型。
- 比如:
- 释义为数字的单词:
port(端口)
或者price(价格)
- 使用_id结尾的单词:
user_id
或者object_Id
- 使用length/count开头结尾的单词:
max_length
或者mix_count
- 释义为数字的单词:
- 比如:
- 其他类型 str、list、tuple、dict 这些复杂的类型,很难有统一规则让我们去猜变量类型。对于这些变量名,最推荐的方式,就是编写规范文档。
3.使用匈牙利命名法
- 简而言之,匈牙利命名法就是把变量的类型缩写,放到变量名的最前面。
- 这里的类型并不是指的数据类型,而是在代码里面的业务逻辑类型。
- 比如:
- 在代码中有两个变量:
students、teachers
,他们指向的内容都是Person
对象的list
。使用匈牙利后,可以把这两个名字改写成这样:
- students ->
pl_students(p代表的是person、l代表的是list)
- teachers ->
pl_teachers(跟学生同理)
- students ->
- 在代码中有两个变量:
- 比如:
4.变量名尽量短,但是不要太过于短
- 如果说不限制变量名的长度,可能你会写出极强的变量名:
- 比如:
answer_much_question_for_table
- 可以看出来这个变量名相当于一个函数名一样,在代码里调用的时候,也会产生很大的误解。所以
。强烈不推荐。answer_much_question_for_table
- 一个好的变量名长度控制在
两到三个单词左右
- 比如:
5.其他注意事项
- 同一段代码内不要使用过于相似变量名
- 比如:
user
、user1
、user2
等等。
- 比如:
- 不要使用带否定含义的变量名
- 比如:
is_delete
替换is_not_delete
- 比如:
不要使用python 里面的关键字 或者是函数名、对象名作为变量名,并且变量名可以是大小写的字母或_(下划线),不能是数字开头