ST-NMG-002 - 引数の命名規則

ルール ID: ST-NMG-002

範囲: ワークフロー

説明

このルールは、プロジェクト内のすべての引数を分析し、特定の規則に従っているかどうかを判断します。

プロジェクトの引数は、プロジェクトを理解して保守しやすいように、特定の命名規則に従う必要があります。引数名は意味のあるものとし、その型を示す文字を含めるようにします。

• in – 指定されたプロジェクト内では引数のみを使用できます。
• 出力 – 指定されたプロジェクトの外側をデータが通過するようにこの引数を使用できます。
• 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])*$。

上記の正規表現によると、接頭辞で始まり、その後に小文字または大文字が続き、その後に 1 つの数字が続く場合、引数は表現に一致します。

たとえば、ワークフローの引数名が 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])*$。

これらの値を既定値に戻すには、[プロジェクト設定] ウィンドウのルールを右クリックして、[既定値にリセット] をクリックします。