Saltar enlaces

Estructure guiones de FileMaker con comentarios en ScriptMaker.

Formación, cursos y coaching sobre FileMaker

Estructuración de guiones de FileMaker con comentariosEste artículo no es una introducción a los guiones de FileMaker. Se trata más bien de la necesidad de comentarios en los guiones de FileMaker. Quienes sólo utilicen los guiones de FileMaker de forma rudimentaria posiblemente puedan prescindir de los comentarios, pero quienes creen aplicaciones enteras en FileMaker harían bien en ceñirse a un sistema estandarizado para comentar la función en general y las secciones de guión en particular. Los guiones complejos constan de muchos comandos de guión. A menudo se ejecutan subguiones adicionales (funciones), se pasan o reciben parámetros, se ejecutan bucles y se utilizan variables. Para mantener una visión general en esta estructura de dependencias, es absolutamente necesario comentar los pasos. Como en las aplicaciones complejas puede ocurrir que los scripts creados no se miren durante mucho tiempo, la estructuración de los scripts mediante comentarios es esencial, al menos en el trabajo en equipo.

Comentarios generales en la cabecera del script

Al principio del guión debe haber un bloque de comentarios generales en el que figuren el autor, la fecha, los datos de contacto y la descripción ( tarea del Guión).

# -------------------------------------------------------------------------------
# Jens Liebelt
# Mayo 2011
# web@jens-liebelt.de
#
# FM4Web
# Crear slider para la cabecera de la página de la edición web.
#
# Este script cambia el diseño.
# Cuando se llama como un script parcial, el script que llama debe volver a la
# diseño original.
# -------------------------------------------------------------------------------

Historial en el guión de FileMaker

Si el guión se modifica en el transcurso del Base de datos se modifica, se puede insertar un bloque de comentarios para el historial. El historial muestra qué cambios se hicieron, cuándo y quién los hizo.

# -------------------------------------------------------------------------------
# Historia
#
# 21/05/2011 Corrección de errores
# Jens Liebelt
# Estado incorrecto de la variable $_filename después de la ejecución
# del subíndice Calcular tamaño de imagen.
# -------------------------------------------------------------------------------

Variables en el guión de FileMaker

Los guiones complejos suelen utilizar variables para el control del proceso y el cálculo de los valores de los campos. En principio, esta opción debería utilizarse siempre; sin embargo, es necesario decidir una ortografía y una designación normalizadas para las variables. Las variables globales deben utilizarse con moderación e inicializarse en un script parcial, de modo que siempre se pueda ver qué variables globales se utilizan en la aplicación. Las variables locales cuya validez se limite al script actual deben anotarse en un bloque de comentarios.

# -------------------------------------------------------------------------------
# Variables locales
#
# $_nombre_archivo
# $_rutaarchivo
# $_fileisuffix
# -------------------------------------------------------------------------------

Parámetros del script

El uso de scripts parciales y variables locales a menudo requiere el uso de parámetros de script (argumentos). De este modo, el valor de una variable local puede pasarse a un script parcial sin perder el valor inicial en el script actual - si es necesario, el valor actual puede sustituirse por el resultado del script parcial (Get ScriptResult).

# -------------------------------------------------------------------------------
# Parámetros de script
# $_filename - Construir nombre de fichero para transferencia a subíndice
# $_filipfad - Construir transferencia a nombre de archivo de subíndice
# -------------------------------------------------------------------------------

Secciones del guión - estructura del guión

Las secciones de un script deben comentarse en bloques. Esto significa que cada sección que representa una secuencia autónoma de comandos se resume en un bloque de comentarios.

#--------------------------------------------------------------------------------
# Deslizador 1
# También se pueden colocar aquí otras explicaciones,
# esto depende de la complejidad del bloque.
#--------------------------------------------------------------------------------
If [ Server::_slider pic 1 ≠ "" ]
Establece la variable [ $_filename; value: "slider_1" & characterRight ( Server::_slider 1 imgPath ; 4 ) ]
Exportar todos los valores de campo [ Server::_slider pic 1; "file:html/images/slider/$_filename" ]
Establecer variable [ $_slider; value:$_slider & "/>¶" ]
Fin (if)
#--------------------------------------------------------------------------------
# Deslizador 2
#--------------------------------------------------------------------------------
If [ Servidor::_slider pic 2 ≠ "" ]
Establecer variable [ $_filename; value: "slider_2" & characterRight ( Server::_slider 2 imgPath ; 4 ) ]
Exportar todos los valores de campo [ Server::_slider pic 2; "file:html/images/slider/$_filename" ]
Establecer variable [ $_slider; value:$_slider & "/>¶" ]
Fin (if)

También se pueden comentar los pasos individuales importantes. Los comentarios deben ayudar y no confundir. No tiene sentido comentar meticulosamente cada paso del guión, ya que esto interrumpe enormemente el flujo del texto fuente. En cualquier caso, los comentarios, cuando se utilizan correctamente, son una herramienta importante para garantizar una visión general de las soluciones FileMaker incluso años después.

Autor: Jens Liebelt

Deja un comentario

Comparta esta página:

Software ERP tan flexible como su empresa.
Estaremos encantados de asesorarle.

Software ERP personalizable para Mac, Windows e iOS.

Usted se encuentra aquí: Uso de comentarios en los guiones de FileMaker para una estructuración significativa.