ST-NMG-001 – Namenskonvention für Variablen

Regel-ID: ST-NMG-001

Scope: Aktivität

Beschreibung

Variablen in einem Projekt müssen einer bestimmten Namenskonvention entsprechen, damit der Zweck der Variablen leichter verstanden und verwaltet werden kann. Der Variablenname sollte aussagekräftig sein, um seine Verwendung im gesamten Projekt genau zu beschreiben.

Diese Regel analysiert alle Variablen im Projekt und ermittelt, ob sie der jeweiligen Konvention entsprechen. Falls nicht, wird eine Meldung im Panel Fehlerliste protokolliert.

Empfehlung

Stellen Sie sicher, dass alle Variablen der Namenskonvention entsprechen. Die Regel prüft, ob die Variablennamen diesem standardmäßigen regulären Ausdruck ^([A-Z]|[a-z])+([0-9])*$ entsprechen.

Gemäß dem regulären Ausdruck oben entspricht sich der Variablenname der Regel, wenn er mit einem Klein- oder Großbuchstaben beginnt, gefolgt von einem Klein- oder Großbuchstaben und dann einer oder mehreren Ziffern.

Beispiel: Wenn der Variablenname im Workflow HelloWorld1 ist, dann entspricht er dem in dieser Regel festgelegten standardmäßigen regulären Ausdruck.

Ändern der Regel

Wählen Sie im Fenster Projekteinstellungen die Registerkarte Workflow-Analyse aus. Suchen Sie die Regel, und wählen Sie sie aus wie in der folgenden Abbildung gezeigt:

Im Abschnitt RegEx können Sie Zeichen zum Suchmuster hinzufügen bzw. daraus entfernen. Beispiel: Wenn Sie den Teil [A-Z] des Ausdrucks entfernen, lautet das Suchmuster ^([a-z])+([0-9])*$. Die Regel überprüft nun, ob Variablen mit einem Kleinbuchstaben beginnen und darauf eine Zahl folgt.

Wird [a-z]|[A-Z]) hinzugefügt, lautet die Regel ^([A-Z]|[a-z]+[a-z]|[A-Z])+([0-9])*$, und HelloWonderfulWorld wird als gültiger Variablenname erkannt.

Beispiele für reguläre Ausdrücke

Der standardmäßige reguläre Ausdruck für diese Regel kann in eine andere Namenskonvention geändert werden. Überprüfen Sie die folgende Liste:

Binnenmajuskeln (CamelCase)

Gemäß der CamelCase-Konvention beginnt jedes Wort in der Mitte des Variablennamens mit einem Großbuchstaben (ohne Zwischenräume oder Interpunktion).

Beispiele für reguläre Ausdrücke: ([A-Z]|[a-z])+([A-Z]|[a-z]|[0-9])

Gültige Variablennamen: Hello1World2, helloWorld, Hello1World.

Binnenmajuskeln mit Initialmajuskel

Gemäß der Pascal-Namenskonvention muss der Name der Variablen verkettete großgeschriebene Wörter enthalten.

Beispiele für reguläre Ausdrücke: ([A-Z])+([A-Z]|[a-z]|[0-9])

Gültige Namen: Hello1World2, HelloWorld, Hello1World.

Kebab-Schreibweise

Die Kebab-Namenskonvention ähnelt der Snake-Namenskonvention. Allerdings werden dabei Leerzeichen nicht durch Unterstriche, sondern durch Bindestriche ersetzt.

Beispiele für reguläre Ausdrücke: ([a-z]|[A-Z])([\w-]+)+([a-z]|[A-Z]|[0-9])

Gültige Namen: Hello1‐World2, Hello‐World.

Auf Standardwerte zurücksetzen

Der Standardwert für ST-NMG-001 ist ^([A-Z]|[a-z])+([0-9])*$.

Einige Workflow Analyzer-Regeln haben Standardwerte. Um den Wert auf den Standardwert zurückzusetzen, klicken Sie mit der rechten Maustaste auf die Regel im Fenster Projekteinstellungen und dann auf Standardwert zurücksetzen.