Comentários

Como uma linguagem de script, o ACLScript permite a adição de comentários com a palavra-chave COMMENT. Use comentários para facilitar a compreensão do seu código e para comunicar-se com qualquer pessoa que tente ler, usar ou compreender o script.

Tipos de comentário

O ACLScript permite dois tipos de comentários:

• comentários de uma linha todo o texto após COMMENT é ignorado até alcançar o final da linha
• blocos de comentários de várias linhas começam com COMMENT e cada linha subsequente é ignorada até alcançar a palavra-chave END ou uma linha em branco

Comentários de uma linha

Use comentários de uma linha para descrever etapas individuais no script ou para descrever variáveis:

COMMENT *** a data de início para o período de análise
v_data_inicial = `20150101`

Blocos de comentários de várias linhas

Use blocos de comentários de várias linhas para descrever scripts ou seções de scripts.

COMMENT
**********************
** Esta seção do script prepara dados para importação
**********************
END

Blocos de comentários de cabeçalho

É uma boa prática incluir um bloco de comentários de cabeçalho com informações importantes sobre o script no início de cada script:

COMMENT
************************************************************
*** Nome do script:   {ID_aplicativo}{Nome do script}
*** Parâmetros:    {Descrição detalhada}
*** Saída:        {Descrever parâmetros}
*** Criado por:    {Nome}, ABC Corporation, {Mês AAAA}
*** Modificado por:   {Nome}, ABC Corporation, propósito e lógica do script
*** Versão:       1.1.1 {vers_apl.vers_script.corr.defeito}
************************************************************
END