ST-NMG-002 – Namenskonvention für Argumente

Regel-ID: ST-NMG-002

Scope: Workflow

Beschreibung

Diese Regel analysiert alle Argumente im Projekt und ermittelt, ob sie der jeweiligen Konvention entsprechen.

Argumente im Projekt müssen einer bestimmten Namenskonvention entsprechen, damit das Projekt leichter verstanden und verwaltet werden kann.

• in: Das Argument kann nur innerhalb des bestimmten Projekts verwendet werden.
• out: Das Argument kann verwendet werden, um Daten außerhalb eines bestimmten Projekts zu übergeben.
• io: Das Argument kann sowohl innerhalb als auch außerhalb eines bestimmten Projekts verwendet werden.

Empfehlung

Stellen Sie sicher, dass alle Argumente der Namenskonvention entsprechen. Der standardmäßige reguläre Ausdruck für diese Regel lautet wie folgt:

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

Gemäß dem oben genannten regulären Ausdruck entspricht das Argument dem Ausdruck, wenn es mit einem Präfix beginnt, auf das ein Klein- oder Großbuchstabe und eine Zahl folgen.

Lautet der Argumentname im Workflow beispielsweise in_HelloWorld, wird er von der Regel validiert. Weitere Beispiele für Argumentnamen, die dieser Regel für reguläre Ausdrücke entsprechen: out_HelloWorld und io_Helloworld.

Ä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 für Eingabeargumente entfernen, lautet das Suchmuster ^in_(dt_)?([a-z])+([0-9])*$. Die Regel überprüft nun, ob Eingabeargumente mit einem Kleinbuchstaben nach dem Präfix beginnen.

Wird [a-z]|[A-Z]) hinzugefügt, lautet die Regel ^in_(dt_)?([A-Z]|[a-z]|[a-z]|[A-Z])+([0-9])*$, und in_HelloWonderfulWorld wird als gültiger Eingabeargumentname 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 Argumentnamens mit einem Großbuchstaben (ohne Zwischenräume oder Interpunktion).

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

Gültige Argumentnamen: in_Hello1World2, in_helloWorld, in_Hello1World.

Binnenmajuskeln mit Initialmajuskel

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

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

Gültige Namen: in_Hello1World2, in_HelloWorld, in_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: ^in_(dt_)?([a-z]|[A-Z]|[0-9])+‐([a-z]|[A-Z]|[0-9])

Gültige Namen: in_Hello1‐World2, in_Hello‐World.

Auf Standardwerte zurücksetzen

Der Standardwerte für ST-NMG-002 sind:

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

Um diese Werte auf den Standardwert zurückzusetzen, klicken Sie mit der rechten Maustaste auf die Regel im Fenster Projekteinstellungen und dann auf Standardwert zurücksetzen.