Notación y convenciones de sintaxis AdvPL
COMANDO <obrigatório> [opcional]Comprende los símbolos y patrones utilizados para documentar comandos y funciones AdvPL.
Descripción general
La documentación AdvPL utiliza una notación estandarizada para distinguir palabras clave, valores obligatorios, cláusulas opcionales, bloques de código, paso por referencia y alternativas de sintaxis. Estos símbolos explican cómo escribir el código, pero no siempre forman parte del comando introducido.
Sintaxis
COMANDO <obrigatório> [opcional]Palabras clave y directivas
#include "TOTVS.ch"
IF lEjecutar
ConOut("Ejecución autorizada")
ENDIF#include identifica una directiva del compilador. IF y ENDIF son palabras clave del comando y se presentan en mayúsculas.
Partes obligatorias y opcionales
IF <condición>
<instrucciones>
[ELSE
<instrucciones alternativas>]
ENDIFLos elementos entre < > deben ser proporcionados por el desarrollador. El bloque entre [ ] es opcional; los delimitadores no se escriben en el código.
Bloques, arrays y paso por referencia
Local aValores := { 1, 2, 3 }
Local bDobro := { |x| x * 2 }
AEval(aValores, bDobro)
Processa(@aValores)Las llaves delimitan arrays literales y bloques de código; las barras verticales delimitan los argumentos del bloque; @ representa el paso por referencia.
Alternativas y repetición
IF ... ELSEIF ... ELSE ... ENDIF
// Notación de alternativas:
<opciónA> / <opciónB>Los puntos suspensivos resumen una secuencia extensa o repetitiva. La barra inclinada separa opciones alternativas en la documentación.
- Las palabras clave de comandos y funciones nativas se presentan en mayúsculas.
- Las directivas del compilador están precedidas por #, como #include.
- Las comas separan cláusulas o argumentos; la barra inclinada indica alternativas.
- Los puntos suspensivos representan secciones repetitivas o extensas.
- Los archivos se presentan en mayúsculas y las extensiones comienzan con punto, como MATA020.PRW.
- Los signos < y > representan información obligatoria y no deben copiarse como parte de la instrucción.
- Los corchetes indican partes opcionales, excepto cuando pertenecen a la sintaxis real de arrays.
- El símbolo @ indica el paso de un argumento por referencia.
- En la convención de la fuente, un asterisco después del nombre identifica un comando o función obsoletos.