Bewährte Methoden zum Benennen von Elementen und Variablen

Identitäten zuweisen

Ossi Galkin avatarGeschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contents

Benennen von Elementen

Die beste Vorgehensweise bei der Benennung von Elementen beruht auf beschreibenden und verständlichen Namen, die nicht zu lang sind, damit der Prozess oder Unterprozess lesbar bleibt. Eine gute Faustregel bei der Benennung von Elementen ist außerdem, die Namenslänge zu begrenzen, damit beispielsweise ein Aufgabenname das Element selbst nicht überschreitet und überläuft. Wenn der Prozess oder Unterprozess einen umfassenderen und längeren Namen für ein Element erfordert, sollten Entwickler die Dokumentationstools für eine bessere Dokumentation verwenden.

Es sollten nur Elemente benannt werden, die für die Logik und Funktionalität des Prozesses oder Unterprozesses relevant sind. Dies geschieht, um zu vermeiden, dass der Prozess mit Informationen überladen wird, die nicht notwendig sind. Beispielsweise kann die Benennung von Rückgabeelementen keine zusätzlichen Informationen liefern, die nützlich wären, daher ist die Benennung weder notwendig noch wünschenswert.

Wie bei jeder anderen Namenskonvention sollte die Benennung von Elementen konsistent und beschreibend sein, um die beste Lesbarkeit eines Prozesses oder Unterprozesses zu gewährleisten.

Variablen benennen

In Frends gibt es drei Arten von Variablen, die benannt werden müssen: Prozessvariablen, Umgebungsvariablen und Variablen in benutzerdefiniertem Code. Sie sollten derselben Namenskonvention folgen. Da Frends C# in Codeanweisungen und Handlebars verwendet, wird empfohlen, in den Variablen dieselbe Namenskonvention wie in C# zu implementieren.

Beim Benennen von Variablen in Frends sollten diese immer kurz, beschreibend und im Camel Case-Stil gehalten sein.

Weitere Informationen finden Sie im Microsoft C#-CodeNamenskonventionen.

Der nächste Artikel istBewährte Methoden für Umgebungsvariablen


Verwandte ArtikelBewährte Methoden für NamenskonventionenBest Practices zur Benennung von Prozessen und UnterprozessenBewährte Methoden zur Benennung von APIsBest Practices zum Anmelden bei FreundenBewährte Methoden für beworbene Variablen