FileMaker Scripte strukturieren durch Kommentare im ScriptMaker.

Strukturieren von FileMaker-Scripten mit KommentarenDieser Artikel ist keine Einführung in FileMaker Scripte. Vielmehr geht um die Notwendigkeit von Kommentaren in FileMaker Scripten. Wer FileMaker Scripte nur rudimentär nutzt, kann möglicherweise auf Kommentare verzichten, wer hingegen ganze Anwendungen in FileMaker erstellt, tut gut daran, sich auf ein einheitliches System zur Kommentierung der Funktion im allgemeinen und den Scriptabschnitten insbesondere zu halten. Komplexe Scripte bestehen aus vielen Scriptbefehlen. Häufig werden zusätzlich Teilscripte (Funktionen) ausgeführt, Parameter übergeben oder empfangen, Schleifen durchlaufen und Variablen verwendet. Damit man in diesem Gebilde der Abhängigkeiten die Übersicht behält, ist es absolut notwendig, die Schritte zu kommentieren. Da es bei komplexen Anwendungen durchaus vorkommt, dass über einen langen Zeitraum nicht mehr in die erstellten Scripte geschaut wird, ist die Strukturierung von Scripten mittels Kommentaren unerläßlich – bei Teamwork sowieso.

Allgemeine Kommentare im Kopf des Scriptes

Am Anfang des Scriptes sollte ein allgemeiner Kommentarblock stehen, in dem der Autor, das Datum, Kontaktdaten und die Beschreibung ( Aufgabe vom Script) vermerkt sind.

# -------------------------------------------------------------------------------
# Jens Liebelt
# Mai 2011
# web@jens-liebelt.de
#
# FM4Web
# Slider für den Seitenkopf der Webausgabe erstellen.
#
# Dieses Script wechselt das Layout.
# Bei Aufruf als Teilscript muss das aufrufende Script wieder in das
# Originallayout wechseln.
# -------------------------------------------------------------------------------

Historie im FileMaker-Script

Wenn das Script im Laufe der Entwicklung der Datenbank geändert wird, kann ein Kommentarblock für die Historie eingefügt werden. Die Historie zeigt, welche Änderungen wann ausgeführt wurden und wer die Änderungen vorgenommen hat.

# -------------------------------------------------------------------------------
# Historie
#
# 21.05.2011 Bugfix
# Jens Liebelt
# Fehlerhafter Zustand der Variablen $_dateiname nach Ausführung
# vom dem Teilscript Bildgröße berechnen.
# -------------------------------------------------------------------------------

Variablen im FileMaker-Script

Komplexe Scripte benutzen in der Regel Variablen für die Ablaufsteuerung und die Berechnung von Feldwerten. Grundsätzlich sollte von dieser Möglichkeit immer Gebrauch gemacht werden – es ist aber notwendig, sich für eine einheitliche Schreibweise und Bezeichnung für Variablen zu entscheiden. Globale Variablen sollten sparsam eingesetzt und in einem Teilscript initialisiert werden, damit man jederzeit sieht, welche globalen Variablen in der Anwendung verwendet werden. Lokale Variablen, deren Gültigkeit auf das aktuelle Script beschränkt sind, sollten in einen Kommentarblock vermerkt werden.

# -------------------------------------------------------------------------------
# Lokale Variablen
#
# $_dateiname
# $_dateipfad
# $_dateisuffix
# -------------------------------------------------------------------------------

Scriptparameter

Der Einsatz von Teilscripten und lokalen Variablen erfordert häufig den Einsatz von Scriptparametern (Argumente). Auf diesem Wege kann der Wert einer lokalen Variablen an ein Teilscript übergeben werden, ohne den Ausgangswert im aktuellen Script zu verlieren – bei Bedarf kann der aktuelle Wert durch das Ergebnis vom Teilscript ersetzt werden (Hole ScriptErgebnis).

# -------------------------------------------------------------------------------
# Scriptparameter
# $_dateiname - Weitergabe an Teilscript Dateiname aufbauen
# $_dateipfad - Weitergabe an Teilscript Dateiname aufbauen
# -------------------------------------------------------------------------------

Scriptabschnitte – Gliederung des Scripts

Die Abschnitte in einem Script sollten in Blöcken kommentiert werden. Das heißt, jeder Abschnitt der eine in sich geschlossene Abfolge von Befehlen darstellt, wird in einem Kommentarblock gefasst.

#--------------------------------------------------------------------------------
# Slider 1
# hier können auch weitere Erläuterungen platziert werden,
# das ist abhängig von der Komplexität des Blockes.
#--------------------------------------------------------------------------------
Wenn [ Server::_slider pic 1 ≠ "" ]
Variable setzen [ $_dateiname; Wert:"slider_1" & ZeichenRechts ( Server::_slider 1 imgPath ; 4 ) ]
Exportiere alle Feldwerte [ Server::_slider pic 1; “file:html/images/slider/$_dateiname” ]
Variable setzen [ $_slider; Wert:$_slider & "/>¶" ]
Ende (wenn)
#--------------------------------------------------------------------------------
# Slider 2
#--------------------------------------------------------------------------------
Wenn [ Server::_slider pic 2 ≠ "" ]
Variable setzen [ $_dateiname; Wert:"slider_2" & ZeichenRechts ( Server::_slider 2 imgPath ; 4 ) ]
Exportiere alle Feldwerte [ Server::_slider pic 2; “file:html/images/slider/$_dateiname” ]
Variable setzen [ $_slider; Wert:$_slider & "/>¶" ]
Ende (wenn)

Wichtige Einzelschritte können dann zusätzlich kommentiert werden. Kommentare sollen helfen und nicht verwirren. Es bringt nichts, jeden Scriptschritt minuziös zu kommentieren, das stört den Lesefluss im Quelltext dann gewaltig. In jedem Fall sind Kommentare, richtig eingesetzt, ein wichtiges Instrument, um die Übersicht von FileMaker-Lösungen auch noch nach Jahren gewährleisten zu können.

Autor: Jens Liebelt

Diesen Beitrag bewerten:

1 Stern2 Sterne3 Sterne4 Sterne5 Sterne (Bisher keine Bewertungen.)
Loading...

Über den Autor

Jens Liebelt
Liebelt Polaris Fachkomponenten Hauptstrasse 23 21646 Holvede• FileMaker Datenbanken • Dynamische Webseiten mit FileMaker • E-Commerce mit FileMaker • FileMaker als NewsBlog System • FileMaker Fernschulung, mit freier Zeiteinteilung • FileMaker Support via TeamViewer

Schreiben Sie einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

10% Rabatt im Onlineshop