Notação e convenções de sintaxe AdvPL
COMANDO <obrigatório> [opcional]Entenda os símbolos e padrões usados para documentar comandos e funções AdvPL.
Visão geral
A documentação AdvPL utiliza uma notação padronizada para diferenciar palavras-chave, valores obrigatórios, cláusulas opcionais, blocos de código, passagem por referência e alternativas de sintaxe. Esses símbolos explicam como escrever o código, mas nem sempre fazem parte do comando digitado.
Sintaxe
COMANDO <obrigatório> [opcional]Palavras-chave e diretivas
#include "TOTVS.ch"
IF lExecutar
ConOut("Execução autorizada")
ENDIF#include identifica uma diretiva do compilador. IF e ENDIF são palavras-chave do comando e aparecem em maiúsculas.
Obrigatório e opcional
IF <condição>
<instruções>
[ELSE
<instruções alternativas>]
ENDIFOs elementos entre < > precisam ser fornecidos pelo desenvolvedor. O bloco entre [ ] é opcional; os delimitadores não são digitados no fonte.
Blocos, arrays e passagem por referência
Local aValores := { 1, 2, 3 }
Local bDobro := { |x| x * 2 }
AEval(aValores, bDobro)
Processa(@aValores)Chaves delimitam arrays literais e blocos de código; barras verticais delimitam argumentos do bloco; @ representa passagem por referência.
Alternativas e repetição
IF ... ELSEIF ... ELSE ... ENDIF
// Notação de alternativas:
<opçãoA> / <opçãoB>Reticências resumem uma sequência extensa ou repetitiva. A barra inclinada separa opções alternativas na documentação.
- Palavras-chave de comandos e funções nativas são apresentadas em letras maiúsculas.
- Diretivas do compilador aparecem precedidas por #, como #include.
- Vírgulas separam cláusulas ou argumentos; a barra inclinada indica opções alternativas.
- Reticências representam trechos repetitivos ou extensos.
- Arquivos são apresentados em maiúsculas e extensões começam com ponto, como MATA020.PRW.
- Os sinais < e > representam informação obrigatória e não devem ser copiados como parte da instrução.
- Colchetes indicam partes opcionais, exceto quando pertencem à sintaxe real de arrays.
- O símbolo @ indica passagem de argumento por referência.
- Um asterisco após o nome identifica, na convenção da fonte, um comando ou uma função obsoleta.