Comment

Category: Annotation

Overview

The Comment node lets you leave a labelled note inside the recipe graph. It is canvas-only — the runtime never enters a Comment node. The publish validator’s reachability check (V2) treats Comment as an annotation type and the kernel registers a defensive handler that escalates the session if a Comment is somehow reached at runtime.

Use it to document the intent of a non-obvious branch, mark a TODO for the next editor, or tag a handoff section in a long recipe.

When to use

• Document why a non-obvious branch exists (“VIP fast-lane — see ticket #1234”).
• Mark in-flow TODOs (“revisit timeout after Q3 launch”) without breaking the graph.
• Tag handoff sections in long sub-flows so a second author can find their bearings.

Ports

Comment nodes have no input or output ports. They are designer-only — the kernel filters them out of the advance loop by node type. (For a free-floating annotation that doesn’t sit on the graph at all, use a Sticky Note instead.)

Configuration

Note

A plain-text designer note. Markdown is supported in the field but never rendered to a customer because the runtime never executes the node.

Limits & validation

• The runtime escalates with comment_node_reached_at_runtime if any wiring or version-mismatch somehow lands the kernel on a Comment node — this is a defensive sentinel and should never fire in a clean recipe.
• Comment nodes never block publish.

See also

Sticky Note for free-floating annotations that aren’t tied to a graph position at all.