命名规则：让你的变量和函数名更具可读性

2023-10-15 15:06:25

正文

在编程中，命名规则是指给变量、函数和其他标识符命名的规则。遵循良好的命名规则可以使代码更具可读性、可维护性和可重用性。

变量名的主要目的是为了使代码易于阅读和理解，因此变量名应做到：

含义明确： 变量名应清楚地传达变量所表示的内容或用途，便于其他程序员快速理解其含义。例如，一个存储用户名的变量可以用 username 命名，而一个存储用户年龄的变量可以用 age 命名。
简洁明了： 变量名应尽可能简洁，但不能牺牲可读性。例如，一个存储用户姓名的变量可以用 lastName 命名，而不是 userLastName 或 strLastName。
使用一致的命名风格： 为了使代码看起来整齐美观，应使用一致的命名风格。例如，可以使用驼峰命名法或下划线命名法，并始终如一地使用它们。
避免使用特殊字符： 变量名中应避免使用特殊字符，如 $、# 或 % 等。特殊字符会使变量名难以阅读和理解，并且在某些编程语言中可能无法使用。
注意变量名的长度： 变量名不宜过长，也不能过短。过长的变量名会使代码难以阅读，过短的变量名又可能不够明确。一般来说，变量名应在2到20个字符之间。

函数名的主要目的是为了说明函数的功能或用途，因此函数名应做到：

含义明确： 函数名应清楚地传达函数的功能或用途，便于其他程序员快速理解其含义。例如，一个计算两个数字之和的函数可以用 sum() 命名，而一个获取当前时间的函数可以用 getCurrentTime() 命名。
简洁明了： 函数名应尽可能简洁，但不能牺牲可读性。例如，一个获取用户姓名的函数可以用 getLastName() 命名，而不是 getUserLastName() 或 strGetLastName()。
使用一致的命名风格： 为了使代码看起来整齐美观，应使用一致的命名风格。例如，可以使用驼峰命名法或下划线命名法，并始终如一地使用它们。
避免使用特殊字符： 函数名中应避免使用特殊字符，如 $、# 或 % 等。特殊字符会使函数名难以阅读和理解，并且在某些编程语言中可能无法使用。
注意函数名的长度： 函数名不宜过长，也不能过短。过长的函数名会使代码难以阅读，过短的函数名又可能不够明确。一般来说，函数名应在2到20个字符之间。

除了上述的一般命名规则之外，还有一些常用的命名约定。这些命名约定可以使代码更具可读性和可维护性，也便于其他程序员快速理解代码的含义。

使用驼峰命名法或下划线命名法： 驼峰命名法是指将每个单词的首字母大写，第一个单词除外。例如，一个存储用户姓名的变量可以用 userName 命名，而一个计算两个数字之和的函数可以用 sumTwoNumbers() 命名。下划线命名法是指在每个单词之间使用下划线。例如，一个存储用户姓名的变量可以用 user_name 命名，而一个计算两个数字之和的函数可以用 sum_two_numbers() 命名。
使用缩写： 在某些情况下，可以使用缩写来使变量名或函数名更简洁。例如，一个存储用户姓名的变量可以用 lastName 或 ln 命名，而一个获取当前时间的函数可以用 getCurrentTime() 或 getTime() 命名。
使用常量： 常量是指在程序运行期间不会改变的值。常量通常用大写字母命名，以使其与变量区分开来。例如，一个存储应用程序版本的常量可以用 APP_VERSION 命名，而一个存储应用程序名称的常量可以用 APP_NAME 命名。