Documentação de fontes e cabeçalhos AdvPL
Registra contrato, dependências e limites junto ao fonte.
Visão geral
Um cabeçalho útil explica finalidade, entradas, retorno e efeitos; comentários internos justificam decisões que não ficam óbvias na instrução. As regras editoriais do projeto exigem comentários didáticos e distinguem análise documental de compilação e execução. A estrutura da linguagem admite comentários, mas não garante que qualquer formato de cabeçalho seja processado por uma ferramenta. O exemplo propõe um comentário simples e um contrato verificável, sem atribuir compatibilidade automática a geradores de documentação. (USINA.BR, 2026, ref. 1; TOTVS, s.d., ref. 2)
Exemplo comentado
#Include "Protheus.ch"
/*
Finalidade: dobrar uma quantidade numerica.
Entrada: nQuantidade, numero; retorno: numero ou Nil.
Efeitos: nenhum acesso a tabelas ou arquivos.
Validacao Protheus: pendente.
*/
User Function Ed357(nQuantidade)
// Rejeitar tipo invalido antes da aritmetica.
If ValType(nQuantidade) <> "N"
Return Nil
EndIf
Return nQuantidade * 2U_Ed357(3) propõe 6; texto propõe Nil, coerente com o comentário. Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.
- Atualizar o contrato junto com o código; não registrar credenciais em comentários.
- Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.
Comentários
Ainda não há comentários aprovados.
Entre com Google ou Microsoft para comentar.