选择简单易懂的名称
除非编写的代码是“一次性”的,仅需运行一次,不需要长期维护,否则应该在命名这件事上花些工夫。如果只是简单地用a,b,c作为变量名,将会花费不必要的心里会议当初这些变量的作用。
计算机并不在乎名称是否言简意赅还是语焉不详。名称的作用是让人更容易阅读而不是让计算机更容易运行。
注意事项
- 不要覆盖内置名称
- 标识符区分大小写,且不能包含空格。
- 数据类型的前缀,需要删除
- 不要带有连续数字后缀的名称
- 如果是在大项目中,查找功能会经常使用,所以请包含具体细节的较长且特殊的名称
- 避免笑话、双关语和需要文化背景才能理解的词汇
命名风格
- 蛇形命名法
(snake_case)用下划线分割单词,两个单词之间的连接看起来像是蛇一样。这种情况下,所有字母都是小写,但常量名经常采用大写,类似于 UPPER_SNAKE_CASE
- 驼峰命名法
(camelCase)从第二个单词开始,每个单词使用首写字母大写进行分隔,也就是第一个单词手写字母小写,后面的单词的大写字幕看起来像驼峰。
- Pascal命名法
(PascalCase)因其在Pascal编程语言中的使用而得名。它跟驼峰命名法类似,但第一个单词的首字母也要大写。
适当的名称长度
-
名称太短
1. 只有一个或两个字母的名称对代码的人而言很省事,但对别人而言很难读懂。
2. 缩写名称比如mon,可以用来代表监视器、月份、怪物等单词
3. 单个词语,像是start,不明白是什么的开始。
-
名称太长
1. 呈现过多的细节,描述性过强的名称
PEP8的命名风格
- 所有的字母应是ASCII字母,也就是没有重音符号的大写和小写的英文字母
- 模块名应该简短,都是小写字母
- 类名应使用Pascal命名法
- 常量名应使用大写字母的蛇形命名法
- 函数名、方法名和变量名应使用小写字母的蛇形命名法
- 方法的第一个参数,应总是命名为小写的self
- 类方法的第一个参数应总是命名为小写的cls
- 类中的私有属性应总是以下划线(_)开头
- 类中的公共属性不应以下划线开头