Etwas Struktur in dein Script bekommen

Wer eine User App entwickelt hat die etwas aufwendiger ist, weiss dass Ordnung nicht nur im wahren Leben die halbe Miete ist, sondern auch bei der Programmierung. Wie ihr etwas Ordnung in eure Programmierung bekommt, versuche ich heute anhand von Beispielen zu erklären.Ich für meinen Teil habe bei der Programmierung einen Tick, der mir oftmals hilft mich in meinen Scripts besser zu Recht zu finden. Das Zauberwort nennt sich „Einrücken„. Fast schon pedantisch achte ich darauf, das dazugehörige Codeteile immer gleich eingerückt sind. So findet man sich gerade in verschachtelten Codezeilen wesentlich einfacher zurecht.

An dem unten stehenden Beispiel handelt es sich nur um eine kleine Funktion, doch die Darstellung verdeutlicht sehr gut, dass die Lesbarkeit zu nimmt, wenn alle Notwendigen Informationen ordentlich eingerückt sind. Denn gerade wenn es längere Codeteile sind, so nimmt die Lesbarkeit drastisch ab.

botsay: function(user, params, command){bot.sendPublicMessage(''+params+'');}

Besser ist es, wenn man wie im untenstehenden Beispiel alles ordentlich gliedert. So lassen sich sehr schnell zum Beispiel fehlende Klammern kontrollieren.

botsay: function(user, params, command) {
     bot.sendPublicMessage(''+params.escapeKCode()+'');
}

Eine weitere Möglichkeit, die auch problemlos kombinierbar ist mit dem Einrücken, ist es wichtige Bestandteile deiner App in einzelne Dateien zu packen und so eine logische Gliederung des Scripts zu gewährleisten. Dies kann man mit der Funktion require(„Pfad zur Datei“); umsetzen. Das untenstehende Beispiel zeigt nun eine beispielhafte main.js, mit dessen Hilfe verschiedenste JavaScriptdateien einmalig eingebunden werden.

var App = {};
     require('config/onAppStart.js');
     require('config/onUserJoined.js');

Ansicht der main.js

App.onAppStart = function() {
     user.sendPrivateMessage('Die App läuft wieder.');
}

Ansicht der onAppStart.js, die sich im Ordner config befindet.

App.onUserJoined = function(user){
     user.sendPrivateMessage('Hallo '+user.getNick()+', schön das du wieder da bist!');
};

Ansicht der onUserJoined.js, die sich im Ordner config befindet.

Wenn ihr diese Programmiertipps beherzigt, sollte euer Code wesentlich leichter zu lesen sein und spätere Änderungen euch leichter von der Hand gehen.

Kommentar verfassen

Trage deine Daten unten ein oder klicke ein Icon um dich einzuloggen:

WordPress.com-Logo

Du kommentierst mit Deinem WordPress.com-Konto. Abmelden / Ändern )

Twitter-Bild

Du kommentierst mit Deinem Twitter-Konto. Abmelden / Ändern )

Facebook-Foto

Du kommentierst mit Deinem Facebook-Konto. Abmelden / Ändern )

Google+ Foto

Du kommentierst mit Deinem Google+-Konto. Abmelden / Ändern )

Verbinde mit %s