SplitScript reference / Language / ///

///

syntax

/// documentation text

Documents a source declaration, state field, setting, or heading.

On functions and methods, global variables, state fields, records and their fields, and enums and their variants, the documentation appears in editor hovers. On settings and headings, it becomes a tooltip in the settings UI. Consecutive documentation-comment lines form paragraphs; use an empty /// line to start a new paragraph.

Examples

Document a source symbol

/// Formats a level number for display.
fn levelLabel(level) {
    return `Level {level}`
}

Add a setting tooltip

/// Splits when the boss is defeated.
"Split boss" => splitBoss: true