Skip to content
Zoan Docs

Comment

Comment

Section titled “Comment”

Type: comment  ·  Package: Core Activities v1.0.0

Place a text note on the canvas to document the playbook: explain what a block does, why a decision was made, or leave a reminder for whoever maintains it. It has no effect at runtime —the bot simply skips it— but it makes the flow much easier to understand.

It’s the equivalent of a comment in code: for people, not for the machine.

How it works

Section titled “How it works”

Drag a Comment activity anywhere in the flow and type the text. At runtime it does nothing and does not appear in the logs. On the canvas, the text shows on the card itself so it can be read at a glance.

Required parameters

Section titled “Required parameters”
ParameterEditorDescription
texttextThe note content (documentation only).

Example

Section titled “Example”

Annotate a section of the flow for whoever reads it later:

Comment   text = "Step 1 — download the daily report from the supplier portal"


Browser Open      url = = config["portalUrl"]   output = nav
Page Click        page = = nav   selector = ...
Section titled “Related activities”
  • Log — if you want the message recorded in the execution (not just on the canvas).