SAPUI5 Coding Guidelines nutzen – so geht’s richtig!
Wenn Sie die vorherigen beiden Beiträge gelesen haben, wissen Sie bereits, wie Sie Ihr Projekt „Entwicklung einer SAPUI5-App“ vorbereiten können. In diesem Beitrag möchte ich Ihnen die Coding Guidelines näher bringen. Diese sind gerade in einer auf JavaScript basierenden Programmiersprache sehr wichtig, da gute Lesbarkeit und Strukturierung Grundvoraussetzungen sind, um im SAPUI5-Umfeld Anwendungen zu entwickeln.
Allgemeine Regelungen
Generell gibt es hier einige Dinge, die Sie vermeiden sollten. Die Verwendung von globalen Variablen erschwert die Lesbarkeit des Codings und bei größeren Klassen wird es zusätzlich schwer, alle globalen Variablen präsent zu haben und diese effektiv zu nutzen.
Sie sollten ebenfalls vermeiden, interne Variablen von anderen Objekten zu verwenden. Hier können unvorhersehbare Seiteneffekte auftreten, wenn die internen Mechanismen die Variable wieder überschreiben oder anders herum.
Der Befehl „console.log()“ schreibt Inhalte für alle, die die F12-Taste drücken, sichtbar in das Log des Browsers. Verwenden Sie diesen Befehl daher am besten nur für Entwicklungen und deaktivieren Sie ihn zur Auslieferung des Produkts.
Code-Formatierung
Die Lesbarkeit von Code erhöht sich stark, wenn Sie eine eine optimale Formatierung verwenden. Mit der Nutzung der SAP Web IDE ist diese Formatierungsfunktion bereits eingebaut und kann mit STRG+ALT+B genutzt werden. Weitere hilfreiche Tastenkombinationen können Sie sich auch hier ansehen.
Die Automatische Formatierung kümmert sich unter anderem um die folgenden Punkte:
Hinzufügen und Entfernen von:
- Tabs unter Funktionsdeklarationen
- Leerzeilen nach Funktionen
- Leerzeichen zwischen Operatoren
Die Formatierung sieht dann folgendermaßen aus:
Formatierung Coding Guidelines
Namenskonventionen
Die Deklaration von Variablen hat im JavaScript-Umfeld einen hohen Stellenwert. Teilweise ist es nur über den Namen möglich, zu erkennen, was für einen Typ diese Variable darstellen soll. Das hängt damit zusammen, dass erst zur Laufzeit festgelegt wird, welcher Typ benötigt wird. Daher empfehle ich, zum einen die ungarische Notation sowie CamelCase zu verwenden.
Die Bezeichnung der einzelnen Variablen würde dann wie folgt aussehen:
Namenskonventionen
Zusammenfassung
Es gibt noch weitere sinnvolle Konventionen, die Sie sich hier ansehen können. Mit den oben genannten Punkten haben Sie aber bereits eine solide Grundlage. Mein Tipp ist also, sich im Vorfeld eine sinnvolle Namenskonvention zu überlegen und regelmäßig mit der Tastenkombination STRG+ALT+B zu arbeiten.
Sind für Sie noch Fragen offen geblieben oder haben Sie in diesem Bereich bereits wichtige Erfahrungen gemacht, die hier nicht beschrieben wurden? Lassen Sie es mich gern in den Kommentaren wissen. Ich freue mich auf den Austausch!
Digitales Lernsystem zur Förderung Ihrer Mitarbeiter
Ein digitales Lernsystem oder Lernmanagement genannt ist das Herzstück der heutigen Personalabteilung und Entwicklung. Erfahren Sie mehr darüber!
