Skip to content

comment

Syntax

comment [<comment_id>] { ... }

Description

This introduces a comment block, used to provided documentation or metadata for a model or model file. The pound symbol can be used for single-line comments. Comment blocks are optional and are ignored by the FRED compiler.

It is considered good practice to include metadata about a model at the top of main file. This might include a model name, the author or contributors, the creation date, and last modification data of the model.

Comment blocks may appear anywhere in the program and may include other code blocks within the comment.

Examples

This example shows a possible metadata block.

comment Metadata {
    Model Name: Pandemic Influenza
    Author: John Doe
    FRED Version: 10.0.1
    Created:  01-Jan-2021
    Modified: 05-Jun-2021

    This model implements a pandemic influenza disease....
}

See Also