Comment nodes

Comments are used to visually group and annotate nodes within the IO designer. They help organize complex flows by adding descriptive information and allowing multiple nodes to be managed and moved together as a single block.

Comment one or more nodes

1. Select one or more nodes in the IO grid (hold Ctrl key to select multiple), then right-click.

2. Press the dedicated add comment button.

3. A pop-up will be displayed with the comment designer. Here you can set the title and description that will be visible on the IO designer.

4. You can also customize the comment appearance, including border, background, and text colors.

5. At the end, press the done button and the comment will appear.

Edit a comment

Right click on the comment area and select edit comment.

Resize the comment area

The comment area can be expanded or minimized by dragging its corners with the mouse. You can also right click on the comment area and use the Auto-Resize button to adjust its size automatically.

Note: All nodes inside the comment area are treated as a single block. Dragging the comment area moves all contained nodes together, making it easier to organize multiple nodes as a single group.

Delete a comment

Right click on the comment area, select delete comment, and confirm.

Deleting a comment only removes the comment box, not the nodes it contains.

Use cases for comments

Organize complex flows

Group related nodes together:

• Authentication sequence

• Data validation steps

• Error handling blocks

• API integration section

Document flow logic

Add explanatory notes:

• Business rule descriptions

• Integration requirements

• Special handling notes

• TODO items for future updates

Team collaboration

Improve communication:

• Mark sections for review

• Identify areas needing attention

• Document design decisions

• Highlight temporary solutions

Comment best practices

Descriptive titles

Use clear, concise titles that describe the grouped nodes:

• ✅ "User Authentication"

• ✅ "Validate Profile Data"

• ❌ "Group 1"

• ❌ "Nodes"

Meaningful descriptions

Add context in the description:

• What the grouped nodes accomplish

• Why this approach was chosen

• Any dependencies or requirements

• Known issues or limitations

Visual organization

Use colors strategically:

• Green: Completed, stable sections

• Yellow: Work in progress

• Red: Known issues or needs attention

• Blue: Standard processing blocks

Sizing

• Keep comment boxes appropriately sized

• Don't overlap comments unless intentionally showing relationships

• Use auto-resize to maintain clean appearance

• Leave space between comment groups for clarity

Comments vs. node names

Comments are for grouping and documenting multiple nodes:

• Provide context for a flow section

• Group related nodes visually

• Add detailed explanations

Node names are for individual nodes:

• Describe specific node purpose

• Should be concise

• Help identify nodes quickly

Use both for maximum clarity in complex flows.

Advanced usage

Nested organization

While you cannot nest comments, you can create a hierarchy through positioning and coloring:

• Main flow sections in one color

• Sub-sections in another color

• Position sub-sections near related main sections

Version documentation

Use comments to document changes:

• Add date and author in description

• Note what was changed and why

• Reference related version numbers or tickets

Next steps

• Manage variables

• Copy nodes

• Design flows

• Flow versioning