Einführung in die Dokumentation

Ossi Galkin avatarGeschrieben vonOssi Galkin Vor über einer Woche aktualisiert

Dokumentation ist ein wesentlicher Bestandteil der Best Practices bei der Frends-Entwicklung, und es gibt verschiedene Möglichkeiten, einen Prozess zu dokumentieren. Entwickler sollten während der Implementierung dokumentieren, um sicherzustellen, dass die Prozesse lesbar und leicht verständlich sind.

Frends stellt vier verschiedene Elemente zur Dokumentation bereit, zusätzlich zu den möglichen Beschreibungsfeldern in den Parametern der Elemente. Die folgenden Dokumentationselemente bieten keine Funktionalität und beeinflussen die Prozessausführung in keiner Weise:

  • Textanmerkung

  • Datenobjekt und Datenspeicher

  • Gruppe

Darüber hinaus können Elemente in einem Prozess farblich hervorgehoben werden, um die Dokumentation zu erleichtern.

Der nächste Artikel istBeispiel zur Verwendung von Datenobjekten und Datenspeicherelementen.


Verwandte ArtikelEinführung in C#-Datentypen in FrendsEinführung in JSON-ObjekteBewährte Methoden zum Benennen von Elementen und VariablenBeispiel zur Verwendung von TooltipsBeispiel zur Verwendung von Datenobjekten und Datenspeicherelementen