HiLang Documentation

Documentation is delimited by double-quotes and can include any number of lines, HTML documentation or markdown text. The documentation is added to the generated code as summary comments that are included in tool-tip information when the domain model is used by a developer. They are distinct from “/* … */” comments and can be applied to any element, field, value or extent. When the XMI export/import is selected by a command line tool, the documentation is synchronized with a modelling tool.

Plan.Resource is an example where documentation is provided for an entity

"
Resource planning is the process of determining how a business will allocate resources in a project, 
such as assigning tasks to individuals based on their skills and availability. 

It helps balance demand and capacity across projects, allowing you to keep tight 
timelines and manage stakeholder expectations.
"
entity Plan.Resource : Versioned
                     = Node (SKey = SKey, Name = Name, TypeName = "Plan-Resource")
(
    Name      : String
)
{
    "Description of the resource"
    Notes     : String,

    "Dates the resource is available"
    Duration  : Plan.Duration,

    "Cost each time the resource is used"
    UseCost   : Decimal,

    "Cost per hour of resource usage"
    TimeCost  : Decimal
}
[
    Booked    : Booking.Timesheet (Resource = this)
];

is generated (in C#) as

    /* Summary: Resource planning is the process of determining how a business will allocate resources in a project, such as assigning tasks to individuals based on their skills and availability. It helps balance demand and capacity across projects, allowing you to keep tight timelines and manage stakeholder expectations. 
    */

    [Versioned()]
    [ProtoContract]
    public partial class Resource : Hiperspace.ElementVersion<Resource>
    {
....		
        /* Summary: Description of the resource 
        */
        [ProtoMember(3)]
        public String? Notes
...