ST-NMG-001 - 変数の命名規則

ルール ID: ST-NMG-001

範囲: アクティビティ

説明

プロジェクトの変数は、変数の目的を理解し、それを維持しやすくするために、特定の命名規則に従う必要があります。変数名は、プロジェクト全体でその使用法を正しく説明するために意味のあるものでなければなりません。

このルールは、プロジェクト内のすべての変数を分析し、特定の規則に従っているかどうかを判断します。従っていない場合、メッセージが [エラー リスト] パネルに記録されます。

推奨

すべての変数が命名規則に従っていることを確認してください。ルールは、変数名がこの既定の正規表現 ^([A-Z]|[a-z])+([0-9])*$ に従っていることを確認します。

上記の正規表現によると、変数名が小文字または大文字で始まり、その後に小文字または大文字が続き、その後に 1 つ以上の数字が続く場合、変数名はルールに従っています。

たとえば、ワークフローの変数名が HelloWorld1 の場合、このルールで設定されている既定の正規表現式と一致します。

ルールの変更

[プロジェクト設定] ウィンドウで、[Workflow Analyzer] タブを選択します。以下の画像のように、ルールを見つけてルールを選択します。

[正規表現] セクションで、検索パターンに文字を追加または削除します。たとえば、式の [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])*$ です。

ワークフロー アナライザーのルールの中には既定値を持つものがあります。これらの値を既定値に戻すには、[プロジェクト設定] ウィンドウのルールを右クリックして、[既定値にリセット] をクリックします。