ST-NMG-002 - 参数命名约定

ST-NMG-002 工作流分析器规则，用于分析项目中的所有参数以验证它们是否遵循所需的命名约定。

规则 ID：ST-NMG-002

作用域：工作流

描述

此规则用于分析项目中的所有参数，并确定它们是否符合特定约定。

项目中的参数应遵循特定命名约定，以使项目更易理解和维护。参数名称应富有意义，并包含一类指示：

• “in”– 此参数只能在给定项目内部使用。
• “out”– 此参数可用于向给定项目之外传递数据。
• “io”– 此参数可在给定项目内外部使用。

建议

请确保所有参数均遵循相应的命名约定。此规则的默认正则表达式如下：

• InRegex：^in_(dt_)?([A-Z]|[a-z])+([0-9])*$
• OutRegex：^out_(dt_)?([A-Z]|[a-z])+([0-9])*$
• InOutRegex：^io_(dt_)?([A-Z]|[a-z])+([0-9])*$。

根据上述正则表达式，如果参数以前缀开头，后跟一个小写或大写字母，然后紧接一个数字，那么该参数便符合表达式要求。

例如，如果工作流中的参数名称为 in_HelloWorld，则该参数将由此规则进行验证。其他符合此正则表达式规则的参数名称示例有：out_HelloWorld 和 io_Helloworld。

修改规则

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

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

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

正则表达式示例

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

驼峰式命名法

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

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

有效的参数名称：in_Hello1World2、in_helloWorld、in_Hello1World。

帕斯卡命名法

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

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

有效名称：in_Hello1World2、in_HelloWorld、in_Hello1World。

烤串命名法

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

正则表达式示例：^in_(dt_)?([a-z]|[A-Z]|[0-9])+‐([a-z]|[A-Z]|[0-9])

有效名称：in_Hello1‐World2、in_Hello‐World。

重置为默认值

ST-NMG-002 正则表达式的默认值为：

• InRegex：^in_(dt_)?([A-Z]|[a-z])+([0-9])*$
• OutRegex：^out_(dt_)?([A-Z]|[a-z])+([0-9])*$
• InOutRegex：^io_(dt_)?([A-Z]|[a-z])+([0-9])*$。

要将这些值重置为默认值，请右键单击“项目设置”窗口中的规则，然后单击“重置为默认值”。