Přeskočit odkazy

Strukturování skriptů FileMakeru pomocí komentářů v aplikaci ScriptMaker.

Školení, kurzy a koučování FileMakeru

Strukturování skriptů FileMaker pomocí komentářůTento článek není úvodem do skriptů FileMakeru. Je spíše o nutnosti komentářů ve skriptech FileMakeru. Ti, kteří skripty FileMakeru používají pouze základním způsobem, se bez komentářů možná obejdou, ale ti, kteří ve FileMakeru vytvářejí celé aplikace, by udělali dobře, kdyby se drželi standardizovaného systému komentování funkcí obecně a částí skriptů zvláště. Složité skripty se skládají z mnoha skriptových příkazů. Často se provádějí další dílčí skripty (funkce), předávají se nebo přijímají parametry, procházejí se smyčky a používají se proměnné. Pro zachování přehledu v této struktuře závislostí je bezpodmínečně nutné jednotlivé kroky komentovat. Protože se u složitých aplikací může stát, že se na vytvořené skripty dlouho nedíváme, je strukturování skriptů pomocí komentářů nezbytné - každopádně při týmové práci.

Obecné poznámky v záhlaví skriptu

Na začátku skriptu by měl být obecný blok s komentářem, ve kterém by měl být uveden autor, datum, kontaktní údaje a popis ( úkol ze skriptu). Skript).

# -------------------------------------------------------------------------------
# Jens Liebelt
# květen 2011
# web@jens-liebelt.de
#
# FM4Web
# Vytvoření posuvníku pro záhlaví stránky webového vydání.
#
# Tento skript změní rozvržení.
# Pokud je volán jako částečný skript, musí se volající skript vrátit do složky
# původní rozvržení.
# -------------------------------------------------------------------------------

Historie ve skriptu FileMaker

Pokud je skript v průběhu provádění změny Databáze je změněn, lze do historie vložit blok komentářů. V historii je uvedeno, které změny byly provedeny, kdy a kdo je provedl.

# -------------------------------------------------------------------------------
# Historie
#
# 21/05/2011 Oprava chyb
# Jens Liebelt
# Nesprávný stav proměnné $_filename po provedení.
# z indexu Výpočet velikosti obrázku.
# -------------------------------------------------------------------------------

Proměnné ve skriptu FileMaker

Složité skripty obvykle používají proměnné pro řízení procesu a výpočet hodnot polí. V zásadě by se tato možnost měla používat vždy - je však nutné rozhodnout o standardizovaném zápisu a označení proměnných. Globální proměnné by se měly používat střídmě a měly by být inicializovány v dílčím skriptu, aby bylo vždy vidět, které globální proměnné jsou v aplikaci použity. Lokální proměnné, jejichž platnost je omezena na aktuální skript, by měly být zaznamenány v bloku komentářů.

# -------------------------------------------------------------------------------
# Místní proměnné
#
# $_filename
# $_filelepath
# $_fileisuffix
# -------------------------------------------------------------------------------

Parametry skriptu

Použití dílčích skriptů a místních proměnných často vyžaduje použití parametrů (argumentů) skriptu. Tímto způsobem lze hodnotu lokální proměnné předat dílčímu skriptu, aniž by se ztratila původní hodnota v aktuálním skriptu - v případě potřeby lze aktuální hodnotu nahradit výsledkem dílčího skriptu (Get ScriptResult).

# -------------------------------------------------------------------------------
# Parametry skriptu
# $_filename - Sestavení názvu souboru pro přenos do subskriptu.
# $_filipfad - Sestavení názvu souboru pro přenos do subskriptu
# -------------------------------------------------------------------------------

Sekce skriptu - struktura skriptu

Jednotlivé části skriptu by měly být komentovány v blocích. To znamená, že každá sekce, která představuje samostatnou posloupnost příkazů, je shrnuta v bloku komentářů.

#--------------------------------------------------------------------------------
# Posuvník 1
# Zde lze také umístit další vysvětlení,
# to závisí na složitosti bloku.
#--------------------------------------------------------------------------------
If [ Server::_slider pic 1 ≠ "" ]
Nastavte proměnnou [ $_filename; hodnota: "slider_1" & characterRight ( Server::_slider 1 imgPath ; 4 ) ] ].
Export všech hodnot polí [ Server::_slider pic 1; "file:html/images/slider/$_filename" ]
Nastavte proměnnou [ $_slider; value:$_slider & "/>¶" ]
Konec (if)
#--------------------------------------------------------------------------------
# Slider 2
#--------------------------------------------------------------------------------
If [ Server::_slider pic 2 ≠ "" ]
Nastavte proměnnou [ $_filename; hodnota: "slider_2" & characterRight ( Server::_slider 2 imgPath ; 4 ) ] ].
Export všech hodnot polí [ Server::_slider pic 2; "file:html/images/slider/$_filename" ]
Nastavte proměnnou [ $_slider; hodnota:$_slider & "/>¶" ]
Konec (if)

Důležité jednotlivé kroky pak lze také komentovat. Komentáře by měly pomáhat, nikoliv mást. Nemá smysl pečlivě komentovat každý krok skriptu, protože to velmi narušuje plynulost zdrojového textu. V každém případě jsou komentáře, pokud jsou správně použity, důležitým nástrojem, který zajistí přehled o řešeních FileMakeru i po letech.

Autor: Mgr: Jens Liebelt

Zanechat komentář

Sdílet tuto stránku:

Software ERP je stejně flexibilní jako vaše společnost.
Rádi vám poradíme.

Přizpůsobitelný software ERP pro Mac, Windows a iOS.

Nacházíte se zde: Masarykova univerzita Lidé se mohou těšit na další informace: Použití komentářů ve skriptech FileMakeru pro smysluplné strukturování.