Anotações do JavaScript compatíveis com a função personalizada
As anotações do JavaScript são usadas para fornecer metadados para o código JavaScript. Inclui comentários que começam com símbolos específicos, por exemplo, /** e @. As anotações fornecem informações importantes sobre funções, variáveis e outros elementos no código. O Formulário adaptável é compatível com as seguintes anotações do JavaScript para funções personalizadas:
Nome
O nome é usado para identificar a função personalizada no editor de regras de um Formulário adaptável. As seguintes sintaxes são usadas para nomear uma função personalizada:
@name [functionName] <Function Name>
@function [functionName] <Function Name>
@func [functionName] <Function Name>
.functionName
é o nome da função. Espaços não são permitidos.<Function Name>
é o nome para exibição da função no editor de regras de um Formulário adaptável.
Se o nome da função for idêntico ao nome da própria função, você poderá omitir[functionName]
da sintaxe.
Parâmetro
O parâmetro é uma lista de argumentos usados por funções personalizadas. Uma função pode suportar vários parâmetros. As sintaxes a seguir são usadas para definir um parâmetro em uma função personalizada:
-
@param {type} name <Parameter Description>
-
@argument
{type} name <Parameter Description>
-
@arg
{type}
name <Parameter Description>
.{type}
representa o tipo de parâmetro. Os tipos de parâmetros permitidos são:- string: representa um único valor de string.
- number: representa um único valor numérico.
- booleano: representa um único valor booleano (verdadeiro ou falso).
- cadeia de caracteres []: representa uma matriz de valores de cadeia de caracteres.
- número[]: representa uma matriz de valores numéricos.
- booleano[]: representa uma matriz de valores booleanos.
- date: representa um único valor de data.
- date[]: representa uma matriz de valores de data.
- array: representa uma matriz genérica contendo valores de vários tipos.
- object: representa o objeto de formulário passado para uma função personalizada em vez de passar seu valor diretamente.
- escopo: representa o objeto global, que contém variáveis somente leitura, como instâncias de formulário, instâncias de campo de destino e métodos para executar modificações de formulário em funções personalizadas. Ele é declarado como o último parâmetro nas anotações do JavaScript e não está visível no editor de regras de um Formulário adaptável. O parâmetro scope acessa o objeto do formulário ou componente para acionar a regra ou o evento necessário para o processamento do formulário. Para obter mais informações sobre o objeto Globals e como usá-lo, clique aqui.
O tipo de parâmetro não diferencia maiúsculas de minúsculas e espaços não são permitidos no nome do parâmetro.
<Parameter Description>
contém detalhes sobre a finalidade do parâmetro. Ele pode ter várias palavras.