The comment macro is deprecated.  Please use the description field of other macros to include extra contextual information.

Overview

Annotate workflow templates.

The {comment} macro is used to annotate the workflow template to explain rationale and other useful information.

The comments are only visible while editing the template in the markup editor. They will not be seen by end-users.

Where to use it?

Optional.

One or more {comment} macros can be put in a {workflow} macro.

Parameters

ParameterRequiredDefaultNotesVer

macro body

(tick)

 

The comment:

  • Plain text
  • Can use any character set supported by your Confluence server – except some reserved characters.
4.0+

Example

{workflow:name=Example}
   {comment}
      Plain text comment.
   {comment}
   {state:Example}
   {state}
{workflow}

All examples

See also

Workflow Authoring Guide:

User Guide:

Administration Guides: