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

Informational metadata, doesn’t affect code generation.

In Program/Screen (top level)

Flat Key : value pairs:

KeyDescription
Author NameName of who wrote the program.
Author UserUser ID of who wrote it.
App IdShort application identifier.
App NameVisible application name.
App DescriptionLong application description.
Module IdShort module identifier.
Module NameVisible module name.
Module DescriptionLong module description.
Created AtFree-form date/timestamp (e.g. "12/06/2025"), not parsed or validated.
 
@Documentation {
    Author Name          : Programmer Name
    Author User          : User Code
    App Id               : Application ID
    App Name             : Application Name
    Module Id            : Module ID (if applicable)
    Created At           : "12/06/2025"
}

In Table (nested inside @Structure)

Here @Documentation has no keys of its own, only sub-sections:

  • @Author: Name, User, Company.
  • @Application: Id, Name, Description.
  • @Module: Id, Name, Description.
  • @Repository: Official, Type (e.g. git), Branch, Version.
  • @History: container for @Creation and any number of @Change entries.
    • @Creation: Date, Author, User, Company, Reason.
    • @Change (repeat the block for each entry): Date, Type (by convention breaking/feature/fix/security/performance/refactor/config/docs, not enforced by the compiler), Impact (by convention high/medium/low), Version, Reason, Author, User, Company.
@Structure {
    Name : "GRIDDEMO"
    @Documentation {
        @Author {
            Name : Programmer
        }
        @History {
            @Creation {
                Date   : "2025-06-12"
                Author : Programmer
                Reason : "Initial creation"
            }
            @Change {
                Date    : "2026-01-10"
                Type    : feature
                Impact  : medium
                Reason  : "Adds City column"
            }
        }
    }
    @Fields { ... }
}