Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Informações adicionais sobre a padronização da documentação

...

Informações

A utilização dos comandos da linguagem AdvPL depende da correta configuração da pasta de <includes> fornecida junto com o ambiente para possibilitar a compilação de  código AdvPL.

Padronização e Informações adicionais

  • A documentação base de um comando deve incluir sua sintaxe mínima e sintaxe completa.
  • Sintaxe mínima: Utilização do comando com o mínimo de parâmetros, apenas os obrigatórios.
  • Sintaxe completa: Descreve todas as cláusulas do comando, obrigatórias e opcionais.
  • Em algumas ocasiões o comando pode não endereçar diretamente todos os parâmetros do método encapsulado pelo comando. Nestes casos, normalmente é possível setar as propriedades adicionais de forma direta no objeto após criado ou mesmo por método. 
  • Cada comando da interface visual normalmente está vinculada ao uso de uma classe da interface visual, e encapsula o construtor NEW() da mesma. Cada comando documentado menciona e aponta por link a classe endereçada, e vice-versa.