Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

@Documentation

Metadatos informativos, no afectan la generación de código.

En Program/Screen (nivel superior)

Pares planos Clave : valor:

ClaveDescripción
Author NameNombre de quien escribió el programa.
Author UserUser ID de quien lo escribió.
App IdIdentificador corto de la aplicación.
App NameNombre visible de la aplicación.
App DescriptionDescripción larga de la aplicación.
Module IdIdentificador corto del módulo.
Module NameNombre visible del módulo.
Module DescriptionDescripción larga del módulo.
Created AtFecha/timestamp libre (p.ej. "12/06/2025"), no se parsea ni valida.
@Documentation {
    Author Name          : Nombre del Programador
    Author User          : Codigo de Usuario
    App Id               : ID de la Aplicación
    App Name             : Nombre de la Aplicación
    Module Id            : ID del Módulo (si aplica)
    Created At           : "12/06/2025"
}

En Table (anidada dentro de @Structure)

Aquí @Documentation no tiene claves propias, sólo sub-secciones:

  • @Author: Name, User, Company.
  • @Application: Id, Name, Description.
  • @Module: Id, Name, Description.
  • @Repository: Official, Type (p.ej. git), Branch, Version.
  • @History: contenedor de @Creation y cualquier cantidad de @Change.
    • @Creation: Date, Author, User, Company, Reason.
    • @Change (repetir el bloque por cada entrada): Date, Type (por convención breaking/feature/fix/security/performance/refactor/config/docs, no forzado por el compilador), Impact (por convención high/medium/low), Version, Reason, Author, User, Company.
@Structure {
    Name : "GRIDDEMO"
    @Documentation {
        @Author {
            Name : Programador
        }
        @History {
            @Creation {
                Date   : "2025-06-12"
                Author : Programador
                Reason : "Alta inicial"
            }
            @Change {
                Date    : "2026-01-10"
                Type    : feature
                Impact  : medium
                Reason  : "Agrega columna Ciudad"
            }
        }
    }
    @Fields { ... }
}