每个程序员需掌握的20个代码命名小贴士

在编写程序的过程中，良好的代码命名是非常重要的，它能够使你的代码更加可读、可维护和易于理解。下面是20个代码命名小贴士，让你写出更好的代码。

1. 命名应具有描述性

代码命名应该具有表现力和描述性，这样阅读代码的人就可以通过代码名称短暂的理解代码的功能。

示例：

# 不好的命名风格
a = 5

# 好的命名风格
number_of_rows = 5

2. 变量名应该具有可读性和易于理解

使用可读性强的变量名称，是确保代码易于理解的关键。

示例：

# 不好的命名风格
n = 10

# 好的命名风格
total_students = 10

3. 给函数和类使用名词或者动词

函数和类名建议使用名词或常规动词，使代码更具可读性和易于理解。

示例：

# 不好的命名风格
def account():...

# 好的命名风格
class Account: ...

4. 给布尔变量增加is前缀

在Bool数据类型应该使用 is 或者 has 作为前缀。

示例：

# 不好的命名风格
isTrue = False

# 好的命名风格
is_login = False

5. 避免使用缩写

避免使用缩写和缩写词。

示例:

# 不好的命名风格
cnt = 4

# 好的命名风格
count = 4

6. 使用有意义且常用的变量名称

变量名称应该是具有意义的单词，而不是随随便便取的一些词汇或者缩写。

示例:

# 不好的命名风格
a = 5

# 好的命名风格
number_of_days = 5

7. 不应该使用数字作为名称的开头

变量命名不应该以数字开头，一般来说，数字比字母更难以识别和记忆。

示例：

# 不好的命名风格
9Lives = "a book."

# 好的命名风格
lives9 = "a book."

8. 将所有字母都小写并使用下划线分隔单词

Python建议将所有字母都小写，并且使用下划线 "_" 分隔单词。

示例：

# 不好的命名风格
numberOfAccounts = 5

# 好的命名风格
number_of_accounts = 5

9. 函数命名应该以动词开头

函数命名应该以一个动词开头，让读者知道该函数执行的操作。

示例：

# 不好的命名风格
def calculate():...

# 好的命名风格
def calculate_total():...

10. 避免使用语言中的关键字作为变量名

不要使用语言中的关键字和保留字作为变量名。

示例：

# 不好的命名风格
class = "Student"

# 好的命名风格
class_name = "Student"

11. 使用完整的词汇名称

使用完整的词汇名称，不要使用缩写或缩略语。

示例：

# 不好的命名风格
x = 10

# 好的命名风格
number_of_items = 10

12. 给变量名增加前缀或者后缀区分作用

给变量名增加前缀或后缀可以使变量名更具可读性和清晰性。

示例：

# 不好的命名风格
value = "fruit"

# 好的命名风格
fruit_value = "fruit"

13. 把重复的代码提取出来

如果有大量重复的代码，将它们放入一个方法中，并为它们取一个有意义的名称。

示例：

# 不好的命名风格
def account():...
def account_1():...
def account_2():...

# 好的命名风格
def account(recipient):...
def account_for_student(student):...
def account_for_employer(employer):...

14. 不要使用太长的名字

名字太长可能导致代码不易读，在变量名、函数名等中寻找平衡。

示例：

# 不好的命名风格
ninth_grade_student_that_joins_classes = 22

# 好的命名风格
ninth_grade_classes_joined = 22

15. 使用数字表示缩写

如果一些单词经常被缩写，可以使用数字表示该单词的开头和末尾字母。

示例：

# 不好的命名风格
dlvry = 10

# 好的命名风格
delivery_num = 10

16. 给常量使用全大写字母

给常量使用全大写，可以使它们更具可读性。

示例：

# 不好的命名风格
total = 10

# 好的命名风格
TOTAL_STUDENTS = 10

17. 不要使用连字号

不要在代码中使用连字符。

示例：

# 不好的命名风格
total_students = 10

# 好的命名风格
totalStudents = 10

18. 名称应该易于拼写

名称应该易于拼写和记忆。

示例：

# 不好的命名风格
stduent = True

# 好的命名风格
student = True

19. 避免使用神秘常量

不要在代码中使用单位或不易识别的常量。

示例：

# 不好的命名风格
h = 6

# 好的命名风格
height = 6

20. 给布尔变量使用肯定词汇

对于布尔类型，使用肯定词汇更容易理解其意义。

示例：

# 不好的命名风格
isNotDone = False

# 好的命名风格
is_complete = False

以上内容详细分享了20个代码命名小贴士，这些贴士能够让你写出更好的代码，使程序更易于理解、阅读、维护。