ST-NMG-001 - 变量命名约定

规则 ID：ST-NMG-001

作用域：活动

描述

项目中的变量应遵循特定命名约定，以便用户更易理解其用途，并予以维护。变量名称应富有意义，需能准确描述变量在项目中的用途。

此规则用于分析项目中的所有变量，并确定它们是否符合特定约定。若不符合，此规则便会在“错误列表”面板中记录错误消息。

建议

请确保所有变量均遵循相应的命名约定。此规则用于检查变量名称是否符合默认的正则表达式：^([A-Z]|[a-z])+([0-9])*$。

根据上述正则表达式，如果变量名称以小写或大写字母开头，后跟一个小写或大写字母，然后紧接一个或多个数字，那么该变量名称便符合此项规则。

例如，如果工作流中的变量名称为 HelloWorld1，那么它将匹配此规则中设置的默认正则表达式。

修改规则

在项目设置窗口中，选择“工作流分析器”选项卡。找到并选中相应规则，如下图所示：

在“正则表达式”部分中，从搜索模式中添加或删除字符。例如，如果删除 In 参数表达式中的 [A-Z] 部分，搜索模式即变为 ^([a-z])+([0-9])*$。此时，此规则将会检查变量是否以小写字母开头，且后跟一个数字。

如果添加 [a-z]|[A-Z])，此规则就会变为 ^([A-Z]|[a-z]+[a-z]|[A-Z])+([0-9])*$，并会将 HelloWonderfulWorld 识别为有效的变量名称。

正则表达式示例

此规则的默认正则表达式可更改为其他命名约定。请查看下表：

驼峰式命名法

驼峰式命名法规定，在变量名称中，除第一个单词外，其余每个单词的首字母都应大写，且不包含空格或标点符号。

正则表达式示例：([A-Z]|[a-z])+([A-Z]|[a-z]|[0-9])。

有效的变量名：Hello1World2、helloWorld、Hello1World。

帕斯卡命名法

帕斯卡命名法规定，变量名称必须由首字母大写的多个单词连结而成。

正则表达式示例：([A-Z])+([A-Z]|[a-z]|[0-9])。

有效名称：Hello1World2、HelloWorld、Hello1World。

烤串命名法

烤串命名法与蛇式命名法类似，不过它使用连字符而非下划线来代替空格。

正则表达式示例：([a-z]|[A-Z])([\w-]+)+([a-z]|[A-Z]|[0-9])

有效名称：Hello1‐World2、Hello‐World。

重置为默认值

ST-NMG-001 正则表达式的默认值为 ^([A-Z]|[a-z])+([0-9])*$。

某些 Workflow Analyzer 规则具有默认值。要将这些值重置为默认值，请在“项目设置”窗口右键单击规则，然后单击“重置为默认值”。