取名艺术 | 你一定能写出更美、更有意义的代码命名

当你在写代码的时候，一定思考过这么一个问题：“怎样为变量、函数、类命名，才能让代码更易读、更容易维护？”

作为开发者，我们总是在寻找最佳命名方法，因为命名无处不在——文件名、类名、方法名、变量名……

所以，虽然命名需要花费一定的时间，但这是完全值得的。本文就将向你介绍一些能够帮助你编写出更优命名的简单规则。

命名原则

1. 见名知意

一个好的命名，应该能够清晰、准确地传达出其含义，让读者能够一眼看清，它到底是什么。

比如，以下变量名就非常清楚地表示了它们的用途：

user_name = 'John Doe'
post_title = 'Hello, world!'

2. 保持一致

在一个项目中，变量、函数、类等命名的风格应该保持一致，这将有助于读者快速地熟悉代码。

最常见的命名风格有两种：

• 蛇形命名法 ：变量名全部小写，单词之间用下划线分隔，如 user_name、post_title。
• 驼峰命名法 ：变量名的首字母小写，后续单词的首字母大写，如 userName、postTitle。

你可以选择其中一种，然后在整个项目中统一使用。

3. 使用缩写

为了避免变量名太长，你可以使用缩写。但是，缩写必须是众所周知的，或者在代码中进行了注释。

比如，以下变量名就使用了缩写：

db = 'database'
http = 'hypertext transfer protocol'

4. 避免使用特殊字符

在变量名中，尽量避免使用特殊字符，如 $、%、& 等。这些字符可能会导致代码出现问题。

5. 保持命名简洁

变量名应该尽量简洁，但也要能够清楚地表达出其含义。

比如，以下变量名就过于冗长：

user_name_in_the_database = 'John Doe'
post_title_on_the_webpage = 'Hello, world!'

你可以将它们简化为：

user_name = 'John Doe'
post_title = 'Hello, world!'

命名规则

1. 变量命名

• 使用小写字母和下划线。
• 变量名应该能够清楚地表达出其含义。
• 避免使用特殊字符。
• 保持命名简洁。

2. 函数命名

• 使用动词和名词的组合。
• 函数名应该能够清楚地表达出其功能。
• 避免使用特殊字符。
• 保持命名简洁。

3. 类命名

• 使用名词。
• 类名应该能够清楚地表达出其类型。
• 避免使用特殊字符。
• 保持命名简洁。

4. 文件命名

• 使用小写字母和下划线。
• 文件名应该能够清楚地表达出其内容。
• 避免使用特殊字符。
• 保持命名简洁。

命名技巧

1. 使用有意义的单词

在为变量、函数、类等命名时，尽量使用有意义的单词。这将有助于读者快速地理解代码。

2. 使用一致的命名风格

在一个项目中，变量、函数、类等命名的风格应该保持一致。这将有助于读者快速地熟悉代码。

3. 使用缩写

为了避免变量名太长，你可以使用缩写。但是，缩写必须是众所周知的，或者在代码中进行了注释。

4. 避免使用特殊字符

在变量名中，尽量避免使用特殊字符，如 $、%、& 等。这些字符可能会导致代码出现问题。

5. 保持命名简洁

变量名应该尽量简洁，但也要能够清楚地表达出其含义。

希望通过这些规则和技巧，能够帮助你写出更优的代码命名。