Comment

Uncontrolled node

Overview

The Comment node allows you to add a comment to the workflow. It serves as a visual annotation tool for documenting your automation logic, leaving notes for collaborators, or explaining complex node configurations directly on the canvas. Comments support Markdown formatting and customizable background colors to help organize your workflow documentation.

Properties

Property	Type	Description	Default
Text	Markdown	The comment content displayed in the node. Supports full Markdown syntax including headers, lists, bold, italic, code blocks, and links.	-
Color	Color	Background color of the comment box. Select from a palette of pastel colors to categorize or highlight different sections of your workflow.	#FFF2AA

Inputs

This node has no inputs.

Outputs

This node has no outputs.

Runtime Behavior

The Comment node is a purely visual element that does not execute any logic during workflow runtime. It is ignored by the execution engine and produces no data or events. Comments are only visible in the workflow editor and serve as documentation for the workflow design. The node supports resizing by dragging the edges to accommodate longer text content.

Example

Documenting a Complex Workflow Section

Place a Comment node near a complex data processing section to explain the logic:

1. Drag a Comment node from the Editor palette onto the canvas near the nodes you want to document
2. Double-click the node to enter edit mode (or edit via the properties panel)
3. Enter your documentation using Markdown:

   ## Data Validation Steps
   
   This section performs the following:
   - Removes rows with missing email addresses
   - Validates phone number formats using regex
   - Converts all dates to UTC timezone
   
   **Note:** Check the filter settings if validation fails
4. Select a background color (e.g., light blue #86E6D9 for validation steps, or keep the default yellow #FFF2AA for general notes)
5. Resize the node by dragging the corner handles to fit your content

The comment will remain visible on the canvas to help you and your team understand the workflow structure, but will not affect execution when the workflow runs.