FUNDAMENTOEn revisión

Documentación de fuentes y cabeceras AdvPL

Registra contrato, dependencias y límites junto al fuente.

Documentación de fuentes y cabeceras AdvPLAdvPL

01 · DESCRIPCIÓN GENERAL

Descripción general

Cabecera útil explica finalidad, entrada, retorno y efectos; comentarios internos justifican decisiones. Reglas editoriales exigen comentarios didácticos y distinguen análisis, compilación y ejecución. Lenguaje admite comentarios sin garantizar procesamiento de cualquier formato por herramientas. Ejemplo propone comentario simple y contrato verificable sin atribuir compatibilidad automática con generadores. (USINA.BR, 2026, ref. 1; TOTVS, s.f., ref. 2)

03 · EJEMPLO PRÁCTICO

Ejemplo comentado

#Include "Protheus.ch"
/*
Finalidad: duplicar cantidad numerica.
Entrada: nCantidad, numero; retorno: numero o Nil.
Efectos: sin acceso a tablas ni archivos.
Validacion Protheus: pendiente.
*/
User Function Ed357(nCantidad)
    // Rechazar tipo invalido antes de aritmetica.
    If ValType(nCantidad) <> "N"
        Return Nil
    EndIf
Return nCantidad * 2

Resultado esperado

U_Ed357(3) propone 6; texto propone Nil, coherente con comentario. En revisión: ejemplo editorial no compilado ni ejecutado en Protheus. Comprobar includes, release, RDD y contexto antes de probar.

BUENAS PRÁCTICAS

Actualizar contrato junto con código; no registrar credenciales en comentarios.
En revisión: ejemplo editorial no compilado ni ejecutado en Protheus. Comprobar includes, release, RDD y contexto antes de probar.

Contenido relacionado

REFERENCIAS

Estado: En revisión
Página creada el: 26/10/2026 a las 12:03
Última revisión el: 26/10/2026 a las 12:03
Idioma original: Portugués
Revisión: Usina.BR