Koppelingen overslaan

FileMaker-scripts structureren met commentaar in ScriptMaker.

FileMaker training, cursussen, coaching

FileMaker-scripts structureren met commentaarDit artikel is geen inleiding in FileMaker scripts. Het gaat eerder over de noodzaak van commentaar in FileMaker scripts. Degenen die FileMaker-scripts alleen op een rudimentaire manier gebruiken, kunnen mogelijk zonder commentaar, maar degenen die volledige toepassingen in FileMaker maken, doen er goed aan om vast te houden aan een gestandaardiseerd systeem voor het becommentariëren van de functie in het algemeen en de scriptsecties in het bijzonder. Complexe scripts bestaan uit vele scriptopdrachten. Vaak worden extra subscripts (functies) uitgevoerd, parameters doorgegeven of ontvangen, lussen doorlopen en variabelen gebruikt. Om overzicht te houden in deze structuur van afhankelijkheden, is het absoluut noodzakelijk om de stappen van commentaar te voorzien. Omdat het bij complexe applicaties kan voorkomen dat er lange tijd niet naar de gemaakte scripts wordt gekeken, is het structureren van scripts met behulp van commentaar essentieel - in teamverband in ieder geval.

Algemene opmerkingen in de koptekst van het script

Aan het begin van het script moet een algemeen commentaarblok staan waarin de auteur, de datum, contactgegevens en de beschrijving ( taak van de Script) zijn genoteerd.

# -------------------------------------------------------------------------------
# Jens Liebelt
# mei 2011
# web@jens-liebelt.de
#
# FM4Web
# Slider maken voor de paginakop van de webeditie.
#
# Dit script wijzigt de lay-out.
# Als het script wordt aangeroepen als deelscript, moet het aanroepende script teruggaan naar de
# oorspronkelijke lay-out.
# -------------------------------------------------------------------------------

Geschiedenis in het FileMaker script

Als het script in de loop van de Database is gewijzigd, kan er een commentaarblok worden ingevoegd voor de geschiedenis. De geschiedenis laat zien welke wijzigingen wanneer zijn gemaakt en wie de wijzigingen heeft gemaakt.

# -------------------------------------------------------------------------------
# Geschiedenis
#
# 21/05/2011 Bugfix
# Jens Liebelt
# Onjuiste status van de variabele $_filename na uitvoering
# van het subscript Afbeeldingsgrootte berekenen.
# -------------------------------------------------------------------------------

Variabelen in het FileMaker-script

Complexe scripts gebruiken over het algemeen variabelen voor procesbesturing en de berekening van veldwaarden. In principe moet deze optie altijd worden gebruikt - het is echter noodzakelijk om te beslissen over een gestandaardiseerde schrijfwijze en benaming voor variabelen. Globale variabelen moeten spaarzaam worden gebruikt en worden geïnitialiseerd in een deelscript, zodat je altijd kunt zien welke globale variabelen worden gebruikt in de toepassing. Lokale variabelen waarvan de geldigheid beperkt is tot het huidige script moeten worden genoteerd in een commentaarblok.

# -------------------------------------------------------------------------------
# Lokale variabelen
#
# $_bestandsnaam
# $_bestandspad
# $_fileisuffix
# -------------------------------------------------------------------------------

Scriptparameters

Het gebruik van deelscripts en lokale variabelen vereist vaak het gebruik van scriptparameters (argumenten). Op deze manier kan de waarde van een lokale variabele worden doorgegeven aan een gedeeltelijk script zonder de initiële waarde in het huidige script te verliezen - indien nodig kan de huidige waarde worden vervangen door het resultaat van het gedeeltelijke script (Get ScriptResult).

# -------------------------------------------------------------------------------
# Script-parameters
# $_filename - Bestandsnaam opbouwen voor overdracht naar subscript
# $_filipfad - Bestandsnaam voor overdracht naar subscript opbouwen
# -------------------------------------------------------------------------------

Scriptsecties - structuur van het script

De secties in een script moeten worden becommentarieerd in blokken. Dit betekent dat elke sectie die een op zichzelf staande reeks commando's vertegenwoordigt, wordt samengevat in een commentaarblok.

#--------------------------------------------------------------------------------
# schuifregelaar 1
# Verdere uitleg kan hier ook geplaatst worden,
# dit is afhankelijk van de complexiteit van het blok.
#--------------------------------------------------------------------------------
Als [ Server::_slider pic 1 ≠ "" ]
Stel variabele [ $_filename; waarde: "slider_1" & characterRight ( Server::_slider 1 imgPath ; 4 ) ] in.
Exporteer alle veldwaarden [ Server::_slider pic 1; "file:html/images/slider/$_filename" ]
Variabele instellen [ $_slider; waarde:$_slider & "/>¶" ]
Einde (als)
#--------------------------------------------------------------------------------
# schuifregelaar 2
#--------------------------------------------------------------------------------
Als [ Server::_slider pic 2 ≠ "" ]
Stel variabele [ $_filename; waarde: "slider_2" & characterRight ( Server::_slider 2 imgPath ; 4 ) ] in.
Exporteer alle veldwaarden [ Server::_slider pic 2; "file:html/images/slider/$_filename" ]
Variabele instellen [ $_slider; waarde:$_slider & "/>¶" ]
Einde (als)

Belangrijke afzonderlijke stappen kunnen dan ook van commentaar worden voorzien. Commentaar moet helpen en niet verwarren. Het heeft geen zin om elke scriptstap minutieus te becommentariëren, omdat dit de stroom van de brontekst enorm verstoort. In elk geval is commentaar, wanneer het correct wordt gebruikt, een belangrijk hulpmiddel om het overzicht over FileMaker-oplossingen ook jaren later nog te bewaren.

Auteur: Jens Liebelt

Laat een reactie achter

Deel deze pagina:

ERP-software zo flexibel als uw bedrijf.
We geven je graag advies.

Aanpasbare ERP-software voor Mac, Windows en iOS.

U bevindt zich hier: Opmerkingen in FileMaker-scripts gebruiken voor zinvolle structurering.