Skip to content
Zoan Docs

Comment

Comment

Section titled “Comment”

Type: comment  ·  Package: Core Activities v1.0.8

Places 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 run time —the bot simply skips it— but it makes the flow much easier to understand.

It is the equivalent of a code comment: 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 (it supports several lines). At run time it does nothing: the text is not evaluated or written to the logs. On the canvas, the text is shown on the card itself so it can be read at a glance.

Required parameters

Section titled “Required parameters”
ParameterTypeDefaultDescription
textstring—The content of the note (documentation only). Supports several lines.

Optional parameters

Section titled “Optional parameters”

None.

Output

Section titled “Output”

This activity does not return a value.

Example

Section titled “Example”

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

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


Open Browser      url = config["portalUrl"]   → output: nav
Page Click        page = nav   selector = ...

Common errors

Section titled “Common errors”

This activity cannot fail at run time.

Section titled “Related activities”
  • Log — if you want the message recorded in the execution (not only on the canvas).