メインコンテンツまでスキップ

ST-NMG-001 - 変数の命名

ルール ID： ST-NMG-001

スコープ： アクティビティ

説明​

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

このルールはプロジェクト内のすべての変数を分析し、指定された命名規則（Regex、プレフィックス）に従っているかどうかを判断します。従っていない場合は、解析結果ウィンドウにメッセージが記録されます。

st-nmg-01

推奨事項​

すべての変数が命名規則に従っていることを確認してください。このルールは、変数名が設定された Regex 式とプレフィックスに準拠しているかどうかをチェックします。デフォルトでは、プレフィックスのみが設定されています（v_）。

Regex 式を設定する場合（例：^[a-z][a-zA-Z0-9]*$）、変数名が小文字で始まり、大文字・小文字・数字が続く場合にルールに準拠します。また、ルール パラメータで指定されたプレフィックスにも一致する必要があります。

例えば、ワークフロー内の変数名が v_helloWorld1 であれば、このルールに設定されたデフォルトの命名規則に一致します。

警告を解決するには、「変数」パネルで変数の名前を命名規則に合わせて変更してください。

Regex 式の例​

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

キャメル ケース​

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

Regex 式の例：^(dt_)?([A-Z]|[a-z])+([A-Z]|[a-z]|[0-9])。 有効な変数名：Hello1World2、helloWorld、Hello1World。

パスカル ケース​

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

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

プレフィックスの例​

このルールのデフォルト プレフィックスは v_ ですが、特定の命名規則に合わせて変更できます。データ型に基づいた一般的なプレフィックスの例：

  • 文字列： str_（例：str_FirstName）
  • 整数： int_（例：int_Counter）
  • ブール値： bool_（例：bool_IsValid）
  • DataTable： dt_（例：dt_EmployeeData）
  • リスト： list_（例：list_EmailAddresses）
  • 辞書： dict_（例：dict_ConfigSettings）
  • 汎用変数： v_（例：v_Result）

パラメータ​

  • Regex： 変数名を検証するために使用される正規表現。デフォルトでは、このパラメータは空です。Regex の例：^[a-z][a-zA-Z0-9]*$。
  • Prefix： 変数名に必要なプレフィックス。デフォルトは v_。

ルールの変更​

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

デフォルトにリセット​

デフォルトでは、ルールは有効になっています。アナライザー ウィンドウでルールを右クリックし、デフォルトにリセットをクリックすることで、デフォルト設定にリセットできます。

rtd-nmg-001