Codestyle

"Codestyle" bezeichnet den Stil des Programmierens. Um Scripts für andere Entwickler lesbar und vor allem wartbar zu gestalten sollte beim Scripting ein guter Stil, also ein guter Codestyle, bewahrt werden. Eingige kleinere Regeln helfen in einem Script die Übersicht zu bewahren.

Blöcke

Fasst man bestimmte Bereiche eines Scripts, zum Beispiel die Zusammenfassung der Deklaration globaler Variablen oder den Import von Klassen, an bestimmten Stellen zusammen, so könnte man diese als einen Block bezeichnen. Diese Blöcke steigern die Übersichtlichkeit eines Skripts wesentlich.

//!Beanshell

// Imports
import java.myclass;
..
.

// Globale Variablen
foo = "bar";
bar = 0;
..
.

// Methoden
myMethod() {
   print("this is my method!");
}

// Script-Start
..
.

Einrückung

Eingerückter Scriptcode erhöht die Lesbarkeit. Um eine einheitliche Einrückung für Entwickler mit unterschiedlichen Editoren zu gewährleisten, sollten bestenfalls nur Tabs und keine Leerzeichen zur Einrückung verwendet werden.

Dokumentation

Wie in jeder anderen Programmiersprache auch ist die Dokumentation des Sourcecodes eine große Unterstützung bei späterer Erweiterung oder Debugging eines Scripts. Daher sollte die Funktionalität kleinerer oder besonders komplizierter Abschnitte eines Scripts gut dokumentiert werden.

//!Beanshell

// Einzeiliger Kommentar

/* Mehrzeiliger
Kommentar */