Salta i link

Strutturare gli script di FileMaker con i commenti in ScriptMaker.

Formazione, corsi e coaching su FileMaker

Strutturare gli script FileMaker con i commentiQuesto articolo non è un'introduzione agli script FileMaker. Si tratta piuttosto della necessità dei commenti negli script FileMaker. Chi usa gli script di FileMaker solo in modo rudimentale può fare a meno dei commenti, ma chi crea intere applicazioni in FileMaker farebbe bene ad attenersi a un sistema standardizzato per commentare le funzioni in generale e le sezioni di script in particolare. Gli script complessi sono composti da molti comandi di script. Spesso vengono eseguiti ulteriori sotto-script (funzioni), vengono passati o ricevuti parametri, vengono eseguiti cicli e vengono utilizzate variabili. Per mantenere una visione d'insieme in questa struttura di dipendenze, è assolutamente necessario commentare i passaggi. Poiché in applicazioni complesse può accadere che gli script creati non vengano esaminati per un lungo periodo di tempo, la strutturazione degli script mediante commenti è essenziale, in ogni caso nel lavoro di squadra.

Commenti generali nell'intestazione dello script

All'inizio dello script deve essere presente un blocco di commento generale in cui sono indicati l'autore, la data, i dati di contatto e la descrizione (compito dell'opera). Scrittura) sono annotati.

# -------------------------------------------------------------------------------
# Jens Liebelt
# maggio 2011
# web@jens-liebelt.de
#
# FM4Web
# Creare uno slider per l'intestazione della pagina dell'edizione web.
#
# Questo script modifica il layout.
# Quando viene richiamato come script parziale, lo script chiamante deve tornare al layout originale.
# layout originale.
# -------------------------------------------------------------------------------

Storia nello script FileMaker

Se la sceneggiatura viene modificata nel corso del Database è stato modificato, è possibile inserire un blocco di commenti per la cronologia. La cronologia mostra quali modifiche sono state apportate, quando e chi le ha fatte.

# -------------------------------------------------------------------------------
# Storia
#
# 21/05/2011 Correzione di bug
# Jens Liebelt
# Stato errato della variabile $_filename dopo l'esecuzione
# dal pedice Calcolare le dimensioni dell'immagine.
# -------------------------------------------------------------------------------

Variabili nello script FileMaker

Gli script complessi utilizzano generalmente le variabili per il controllo dei processi e il calcolo dei valori dei campi. In linea di principio, questa opzione dovrebbe essere sempre utilizzata; tuttavia, è necessario decidere un'ortografia e una denominazione standardizzata per le variabili. Le variabili globali dovrebbero essere usate con parsimonia e inizializzate in uno script parziale, in modo da poter sempre vedere quali variabili globali sono utilizzate nell'applicazione. Le variabili locali la cui validità è limitata allo script corrente devono essere annotate in un blocco di commento.

# -------------------------------------------------------------------------------
# Variabili locali
#
# $_filename
# $_filepath
# $_fileisuffix
# -------------------------------------------------------------------------------

Parametri dello script

L'uso di script parziali e variabili locali richiede spesso l'uso di parametri di script (argomenti). In questo modo, il valore di una variabile locale può essere passato a uno script parziale senza perdere il valore iniziale nello script corrente; se necessario, il valore corrente può essere sostituito dal risultato dello script parziale (Get ScriptResult).

# -------------------------------------------------------------------------------
Parametri dello script #
# $_filename - Costruire il nome del file per il trasferimento al pedice
# $_filipfad - Costruisce il nome del file per il trasferimento al pedice
# -------------------------------------------------------------------------------

Sezioni dello script - struttura dello script

Le sezioni di uno script devono essere commentate in blocchi. Ciò significa che ogni sezione che rappresenta una sequenza autonoma di comandi è riassunta in un blocco di commenti.

#--------------------------------------------------------------------------------
# Cursore 1
# È possibile inserire qui ulteriori spiegazioni,
# dipende dalla complessità del blocco.
#--------------------------------------------------------------------------------
Se [ Server::_slider pic 1 ≠ "" ]
Imposta la variabile [ $_filename; value: "slider_1" & characterRight ( Server::_slider 1 imgPath ; 4 ) ]
Esporta tutti i valori dei campi [ Server::_slider pic 1; "file:html/images/slider/$_filename" ]
Impostare la variabile [ $_slider; value:$_slider & "/>¶" ]
Fine (if)
#--------------------------------------------------------------------------------
# Cursore 2
#--------------------------------------------------------------------------------
Se [ Server::_slider pic 2 ≠ "" ]
Impostare la variabile [ $_filename; value: "slider_2" & characterRight ( Server::_slider 2 imgPath ; 4 ) ]
Esportare tutti i valori dei campi [ Server::_slider pic 2; "file:html/images/slider/$_filename" ]
Impostare la variabile [ $_slider; value:$_slider & "/>¶" ]
Fine (if)

I singoli passi importanti possono essere commentati. I commenti devono aiutare e non confondere. Non ha senso commentare minuziosamente ogni fase dello script, perché ciò disturba enormemente il flusso del testo sorgente. In ogni caso, i commenti, se usati correttamente, sono uno strumento importante per garantire una visione d'insieme delle soluzioni FileMaker anche a distanza di anni.

Autore: Jens Liebelt

Lascia un commento

Condividi questa pagina:

Un software ERP flessibile come la vostra azienda.
Saremo lieti di consigliarvi.

Software ERP personalizzabile per Mac, Windows e iOS.

Siete qui: Utilizzo dei commenti negli script FileMaker per una strutturazione significativa.