Grundlegende Konzepte von Namenskonventionen
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsEinführung in Namenskonventionen
Bei der Namenskonvention geht es darum, Namen auf eine bestimmte Weise zu vergeben, die es dem Benutzer ermöglicht, Ressourcen besser zu verstehen und zu verwalten. Durch die Arbeit mit einer standardisierten und vereinbarten Namenskonvention kann die Organisation die Kommunikation verbessern, die Verwaltung vereinfachen und die Ressourcen schneller verstehen. Da Frends von Entwicklern und Benutzern verlangt, die Ressourcen zu benennen, ist es wichtig, eine einheitliche Namenskonvention zu haben.
Im Kontext von Frends müssen Benutzer beispielsweise Namen für die folgenden Ressourcen definieren, um grundlegende Anwendungsfälle zu erfüllen:
Prozesse und Unterprozesse
APIs
Ressourcen und Methoden
API-Schlüssel und API-Regelsätze
API-Zugriffsrichtlinien
Elemente in Prozessen und Unterprozessen
Aufgaben
Entscheidungen
Schleifen
Bereiche
Benutzerdefinierter Code
Variablen, Klassen, Funktionen
Variablen
Variablen in Prozessen
Umgebungsvariablen
Variablen in benutzerdefiniertem Code
Rollen
Überwachungsregeln
Im Allgemeinen sollten die Namen sein:
Nur alphabetische und numerische Zeichen
Kurz, aussagekräftig, beschreibend und aussprechbar
Durchsuchbar
Der Schlüssel zu Namenskonventionen liegt letztendlich in Konsistenz und gemeinsam vereinbarten Richtlinien.
Die folgenden Module stellen die gängigsten Best Practices für Namenskonventionen in Frends vor.
Der nächste Artikel istBest Practices zur Benennung von Prozessen und Unterprozessen
Verwandte ArtikelEinführung in die Entwicklungskonzepte von FrendsBest Practices zur Benennung von Prozessen und UnterprozessenBewährte Methoden zum Benennen von Elementen und VariablenBest Practices zu Versionskonventionen in FrendsBest Practices zur Versionierung von APIs