Saltar ligações

Estruturar scripts FileMaker com comentários no ScriptMaker.

Formação, cursos e coaching FileMaker

Estruturação de scripts FileMaker com comentáriosEste artigo não é uma introdução aos scripts da FileMaker. Em vez disso, é sobre a necessidade de comentários nos scripts da FileMaker. Aqueles que apenas utilizam os scripts da FileMaker de uma forma rudimentar podem possivelmente passar sem comentários, mas aqueles que criam aplicações inteiras na FileMaker fariam bem em manter um sistema padronizado para comentar a função em geral e as secções de script em particular. Os scripts complexos consistem em muitos comandos de script. Muitas vezes são executados sub-scripts adicionais (funções), são passados ou recebidos parâmetros, são executados loops e são utilizadas variáveis. Para manter uma visão geral desta estrutura de dependências, é absolutamente necessário comentar os passos. Como pode acontecer, em aplicações complexas, que os scripts criados não sejam analisados durante um longo período de tempo, a estruturação dos scripts através de comentários é essencial - pelo menos no trabalho de equipa.

Comentários gerais no cabeçalho do script

No início do guião, deve haver um bloco de comentários gerais no qual o autor, a data, os dados de contacto e a descrição (tarefa do Script) são registados.

# -------------------------------------------------------------------------------
# Jens Liebelt
# maio de 2011
# web@jens-liebelt.de
#
# FM4Web
# Criar um slider para o cabeçalho da página da edição web.
#
# Este script altera o layout.
# Quando chamado como um script parcial, o script chamador deve retornar ao
# layout original.
# -------------------------------------------------------------------------------

Histórico no script FileMaker

Se o guião for alterado no decurso da Base de dados é alterado, pode ser inserido um bloco de comentários para o histórico. O histórico mostra quais as alterações efectuadas, quando e quem as efectuou.

# -------------------------------------------------------------------------------
História do #
#
# 21/05/2011 Correção de erros
# Jens Liebelt
# Estado incorreto da variável $_filename após a execução
# a partir do subscrito Calcular o tamanho da imagem.
# -------------------------------------------------------------------------------

Variáveis no script FileMaker

Os guiões complexos utilizam geralmente variáveis para o controlo do processo e o cálculo dos valores dos campos. Em princípio, esta opção deve ser sempre utilizada - no entanto, é necessário decidir sobre uma ortografia e designação normalizadas para as variáveis. As variáveis globais devem ser utilizadas com moderação e inicializadas num script parcial, de modo a que seja sempre possível ver que variáveis globais são utilizadas na aplicação. As variáveis locais cuja validade está limitada ao script atual devem ser anotadas num bloco de comentários.

# -------------------------------------------------------------------------------
# Variáveis locais
#
# $_filename
# $_filepath
# $_fileisuffix
# -------------------------------------------------------------------------------

Parâmetros do guião

A utilização de scripts parciais e variáveis locais requer frequentemente a utilização de parâmetros de script (argumentos). Desta forma, o valor de uma variável local pode ser passado para um script parcial sem perder o valor inicial no script atual - se necessário, o valor atual pode ser substituído pelo resultado do script parcial (Get ScriptResult).

# -------------------------------------------------------------------------------
Parâmetros do script #
# $_filename - Nome do ficheiro de construção para passar ao subscrito
# $_filipfad - Criar transferência para o nome do ficheiro subscrito
# -------------------------------------------------------------------------------

Secções do guião - estrutura do guião

As secções de um script devem ser comentadas em blocos. Isto significa que cada secção que representa uma sequência autónoma de comandos é resumida num bloco de comentários.

#--------------------------------------------------------------------------------
# Seletor 1
# Outras explicações também podem ser colocadas aqui,
# isto depende da complexidade do bloco.
#--------------------------------------------------------------------------------
Se [ Servidor::_deslizador pic 1 ≠ "" ]
Definir variável [ $_filename; valor: "slider_1" & characterRight ( Server::_slider 1 imgPath ; 4 ) ]
Exportar todos os valores de campo [ Server::_slider pic 1; "file:html/images/slider/$_filename" ]
Definir variável [ $_slider; valor:$_slider & "/>¶" ]
Fim (se)
#--------------------------------------------------------------------------------
# Deslizador 2
#--------------------------------------------------------------------------------
Se [ Servidor::_slider pic 2 ≠ "" ]
Definir variável [ $_filename; valor: "slider_2" & characterRight ( Server::_slider 2 imgPath ; 4 ) ]
Exportar todos os valores do campo [ Server::_slider pic 2; "file:html/images/slider/$_filename" ]
Definir variável [ $_slider; valor:$_slider & "/>¶" ]
Fim (se)

As etapas individuais importantes também podem ser comentadas. Os comentários devem ajudar e não confundir. Não vale a pena comentar meticulosamente cada passo do script, pois isso interrompe enormemente o fluxo do texto fonte. Em qualquer caso, os comentários, quando utilizados corretamente, são uma ferramenta importante para garantir uma visão geral das soluções FileMaker, mesmo anos mais tarde.

Autor: Jens Liebelt

Deixar um comentário

Partilhar esta página:

Um software ERP tão flexível como a sua empresa.
Teremos todo o prazer em o aconselhar.

Software ERP personalizável para Mac, Windows e iOS.

Você está aqui: Utilizar comentários em scripts FileMaker para uma estruturação significativa.