Abonnieren

UiPath Studio

UiPath Studio-Anleitung

ST-NMG-002 – Namenskonvention für Argumente

Rule 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.

For example, if the argument name in the workflow is in_HelloWorld then it is validated by the rule. Other examples of argument names that follow this regex rule are: out_HelloWorld and 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:

981981

In the Regex section, add or remove characters from the search pattern. For example, if we remove the [A-Z] part of the expression for In arguments, the search pattern becomes ^in_(dt_)?([a-z])+([0-9])*$. Now the rule checks if In arguments start with a lower case letter after the prefix.

If we add [a-z]|[A-Z]), then the rule becomes ^in_(dt_)?([A-Z]|[a-z]|[a-z]|[A-Z])+([0-9])*$, and recognizes in_HelloWonderfulWorld as a valid In argument name.

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).

Example of Regex expression: ^in_(dt_)?([A-Z]|[a-z]|[0-9])+([A-Z]|[a-z]|[0-9]).
Valid argument names: in_Hello1World2, in_helloWorld, in_Hello1World.

Binnenmajuskeln mit Initialmajuskel

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

Example of Regex expression: ^in_(dt_)?([A-Z]|[0-9])+([A-Z]|[a-z]|[0-9]).
Valid names: 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.

Example of Regex expression: ^in_(dt_)?([a-z]|[A-Z]|[0-9])+‐([a-z]|[A-Z]|[0-9])
Valid names: 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.

981981

Aktualisiert vor 2 Jahren


ST-NMG-002 – Namenskonvention für Argumente


Auf API-Referenzseiten sind Änderungsvorschläge beschränkt

Sie können nur Änderungen an dem Textkörperinhalt von Markdown, aber nicht an der API-Spezifikation vorschlagen.