Sauter les liens

Structurer les scripts FileMaker grâce aux commentaires dans ScriptMaker.

Formation FileMaker, cours de formation, coaching

Structuration de scripts FileMaker avec des commentairesCet article n'est pas une introduction aux scripts FileMaker. Il traite plutôt de la nécessité des commentaires dans les scripts FileMaker. Les personnes qui n'utilisent les scripts FileMaker que de manière rudimentaire peuvent éventuellement se passer de commentaires, mais celles qui créent des applications entières dans FileMaker feraient bien de s'en tenir à un système cohérent pour commenter la fonction en général et les sections de script en particulier. Les scripts complexes se composent de nombreuses instructions de script. Souvent, des sous-scripts (fonctions) sont exécutés, des paramètres sont transmis ou reçus, des boucles sont parcourues et des variables sont utilisées. Pour garder une vue d'ensemble dans cet ensemble de dépendances, il est absolument nécessaire de commenter les étapes. Dans le cas d'applications complexes, il peut arriver que l'on ne consulte plus les scripts pendant une longue période.

Commentaires généraux dans l'en-tête du script

Au début du script, il devrait y avoir un bloc de commentaires généraux, dans lequel l'auteur, la date, les coordonnées et la description ( tâche du Script).

# -------------------------------------------------------------------------------
# Jens Liebelt
# mai 2011
# web@jens-liebelt.de
#
# FM4Web
# Créer un slider pour l'en-tête de page de l'édition web.
#
# Ce script change la mise en page.
# En cas d'appel en tant que script partiel, le script appelant doit revenir au
# changer la mise en page d'origine.
# -------------------------------------------------------------------------------

Historique dans le script FileMaker

Si, au cours de l'évolution du script Base de données est modifiée, il est possible d'insérer un bloc de commentaires pour l'historique. L'historique montre quelles modifications ont été effectuées, quand et qui les a effectuées.

# -------------------------------------------------------------------------------
# Historique
#
# 21.05.2011 Correction de bugs
# Jens Liebelt
# Erreur d'état de la variable $_dateiname après exécution
# du sous-script Calculer la taille de l'image.
# -------------------------------------------------------------------------------

Variables dans le script FileMaker

Les scripts complexes utilisent généralement des variables pour le contrôle du déroulement et le calcul des valeurs des champs. En principe, cette possibilité devrait toujours être utilisée - mais il est nécessaire d'opter pour une orthographe et une désignation uniformes des variables. Les variables globales devraient être utilisées avec parcimonie et initialisées dans un sous-script, afin que l'on puisse voir à tout moment quelles variables globales sont utilisées dans l'application. Les variables locales, dont la validité est limitée au script actuel, devraient être notées dans un bloc de commentaires.

# -------------------------------------------------------------------------------
# Variables locales
#
# $_nom_de_fichier
# $_chemin_de_fichier
# $_fichierisuffixe
# -------------------------------------------------------------------------------

Paramètres de script

L'utilisation de sous-scripts et de variables locales nécessite souvent l'utilisation de paramètres de script (arguments). De cette manière, la valeur d'une variable locale peut être transmise à un sous-script sans perdre la valeur initiale dans le script actuel - si nécessaire, la valeur actuelle peut être remplacée par le résultat du sous-script (Obtenir le résultat du script).

# -------------------------------------------------------------------------------
# Paramètres de script
# $_dateiname - Transmission au sous-script Construire le nom de fichier
# $_filefad - Construire le transfert vers le nom de fichier du sous-script
# -------------------------------------------------------------------------------

Sections de script - Structure du script

Les sections d'un script doivent être commentées en blocs. En d'autres termes, chaque section qui représente une séquence fermée d'instructions est résumée dans un bloc de commentaires.

#--------------------------------------------------------------------------------
# Slider 1
# Des explications supplémentaires peuvent également être placées ici,
# cela dépend de la complexité du bloc.
#--------------------------------------------------------------------------------
Si [ Server::_slider pic 1 ≠ "" ] ]
Définir la variable [ $_dateiname ; Valeur : "slider_1" & CaractèreDroit ( Server::_slider 1 imgPath ; 4 ) ] ]
Exporter toutes les valeurs du champ [ Server::_slider pic 1 ; "file:html/images/slider/$_dateiname" ] ]
Définir la variable [ $_slider ; valeur:$_slider & "/>¶" ]
Fin (si)
#--------------------------------------------------------------------------------
# Slider 2
#--------------------------------------------------------------------------------
Si [ Server::_slider pic 2 ≠ "" ] ]
Définir la variable [ $_dateiname ; Valeur : "slider_2" & CaractèreDroit ( Server::_slider 2 imgPath ; 4 ) ] ]
Exporter toutes les valeurs du champ [ Server::_slider pic 2 ; "file:html/images/slider/$_dateiname" ] ]
Définir la variable [ $_slider ; valeur:$_slider & "/>¶" ]
Fin (si)

Les étapes individuelles importantes peuvent ensuite être commentées. Les commentaires doivent aider et non pas embrouiller. Il ne sert à rien de commenter minutieusement chaque action de script, car cela perturbe considérablement le flux de lecture du texte source. Quoi qu'il en soit, les commentaires, lorsqu'ils sont utilisés correctement, sont un instrument important pour garantir la clarté des solutions FileMaker, même après des années.

Auteur : Jens Liebelt

Laisser un commentaire

Partager cette page :

Un logiciel ERP aussi flexible que votre entreprise.
Nous nous ferons un plaisir de vous conseiller.

Logiciel ERP personnalisable pour Mac, Windows et iOS.

Vous êtes ici : Utiliser les commentaires dans les scripts FileMaker pour une structuration judicieuse.