ST-NMG-002 - 引数の命名

ルール ID： ST-NMG-002

スコープ： ワークフロー

説明

プロジェクト内の引数は、引数の目的を理解しやすくして保守を容易にするために、特定の命名規則に従う必要があります。引数名は、プロジェクト全体での使用法を正確に表す意味のある名前にする必要があります。

このルールはプロジェクト内のすべての引数を分析し、特定の規則に従っているかどうかを判断します。従っていない場合は、「解析結果」ウィンドウにメッセージが記録されます。

推奨事項

すべての引数が命名規則に従っていることを確認してください。このルールは、引数名がデフォルトの Regex 式 ^(in\_|out\_|io\_)?([A-Z]|[a-z])+([0-9])*$ に準拠しているかどうかをチェックします。

上記の Regex 式によると、引数名は引数に推奨されるプレフィックス in_、out_、または io_ の後に小文字または大文字で始まり、次に 1 つ以上の数字が続く場合にルールに準拠します。

例えば、ワークフロー内の引数名が in_HelloWorld1 であれば、このルールに設定されたデフォルトの Regex 式に一致します。

Regex 式の例

このルールのデフォルト Regex 式は、別の命名規則に変更できます。以下のリストを確認してください：

キャメル ケース

キャメル ケース規則では、引数名の中間の各単語が大文字で始まり、スペースや句読点を含みません。

Regex 式の例：^in_(dt_)?([A-Z]|[a-z]|[0-9])+([A-Z]|[a-z]|[0-9])。 有効な引数名：in_Hello1World2、in_helloWorld、in_Hello1World。

パスカル ケース

パスカル ケース命名規則では、引数名に連結された大文字化された単語が含まれる必要があります。

Regex 式の例：^in_(dt_)?([A-Z]|[0-9])+([A-Z]|[a-z]|[0-9])。 有効な名前：in_Hello1World2、in_HelloWorld、in_Hello1World。

ケバブ ケース

ケバブ ケース命名規則はスネーク ケースに似ていますが、スペースをアンダースコアではなくハイフンに置き換えます。

プレフィックスの例

このルールのプレフィックスは、プロジェクトの引数の命名規則に合わせて設定できます。引数の方向に基づいた一般的なプレフィックスの例：

• 入力引数： in_（例：in_Config）
• 出力引数： out_（例：out_TransactionData）
• 入出力引数： io_（例：io_RetryNumber）

ルールの変更

リボンで 解析 ボタンのドロップダウンをクリックし、解析の設定を選択してアナライザー ウィンドウを開きます。ルールを見つけて選択します。独自の命名規則に従って Regex または Prefix パラメータを変更できます。

デフォルト値にリセット

ST-NMG-002 Regex のデフォルト値は以下のとおりです：

• 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])*$

これらの値をデフォルトにリセットするには、アナライザー ウィンドウでルールを右クリックし、デフォルトにリセットをクリックします。