用于命名变量、子例程和脚本的准则

您需要确保为变量、子例程和脚本提供有意义的名称。 使用有意义的名称时，可避免假定和混淆。

使用表示变量、子例程或脚本用途的名称

变量、子例程或脚本名称应说明其用途。 名称应回答以下问题：

  • 为什么需要该变量、子例程或脚本？
  • 此变量、子例程或脚本在执行或存储什么？

不良示例：

错误名称的缺省值

优秀示例：

正确名称的缺省值

使用可发音的名称

可发音的名称有助于通信和协作。

错误示例：cpCltDir

正确示例：copyClientDir

在项目开始时就定义命名约定和标准

如果在团队开始处理项目之前就定义命名约定和标准，可确保团队以一致的方式进行开发。

优秀示例：

变量名称
以小写字母开头的驼峰式标准，如 excelRow 中所示。

常量名称
“ALL_CAPS”标准，以下划线分隔，如 MAX_ROWS 中所示。

子例程名称
以大写字母开头的驼峰式标准，如 GetFile 中所示。

使用的语言
如果可能，请在项目中使用英语，除非项目所有者请求使用其他语言。

根据将子例程或脚本编程为要执行的操作对子例程或脚本命名

使用明确表示子例程或脚本用途的名称。 名称应说明子例程或脚本在该上下文中做什么。

错误示例：错误示例是，对于除了将项插入到系统外还执行其他操作的子例程，将该子例程命名为 InsertItem。 例如，此子例程会在插入项之前获取项数据。 请将此子例程拆分为更多子例程，或将其命名为其他名称。

正确示例：对于上述错误示例，可以将 InsertItem 拆分为 GetItemData 和 InsertItem。

变量名称约定

在开发脚本时，可以使用以下变量命名约定。

变量根据其含义命名

错误示例：${success} 存储登录操作状态。

正确示例：${loginSuccessful} 存储登录操作状态。

错误示例：${count} 存储成功处理的文件数。

正确示例：${filesProcessedWithSuccess} 存储成功处理的文件数。

每个概念使用一个词，并使其保持一致

如果将用于存储平均高度的变量命名为 avg_height，那么只要是存储平均值的变量，都应使用 avg_ 来命名，以保持一致性。 理由是要在整个脚本中使名称保持一致。

错误示例：avg_height 和 averageWidth。

正确示例：avg_height 和 avg_width。

子例程命名约定

在开发脚本时，可以使用以下子例程命名约定。

使用至少一个动词和一个名词对子例程命名

动词必须使用现在陈述语气。

错误示例：

  • Email
  • Save

正确示例：

  • SendEmail
  • SaveFile

脚本命名约定

在开发脚本时，可以使用以下脚本命名约定。

将脚本命名为指示其所属的上下文

属于同一上下文的脚本必须按照相同的子例程规则 verb + noun通过命名上下文来开始。 动词必须使用现在陈述语气。

正确示例：

  • fooSystem_loginSite
  • fooSystem_downloadArchives
  • varSystem_extractDataInvoices
  • barSystem_setDataInvoices
  • sendEmail

对通用用途的脚本命名时，可以省略上下文，如 sendEmail。