Introduction

Comments are used to capture background information about the flow. This information can be local (i.e., tied to a specific node) or global (i.e., applying to the flow as a whole).

Comments have a counter associated with them that gets bumped for each comment. The current value of this counter is used to construct the default label for the comment.

Details

Consider the following capture of a portion of a source file,

Images/comment-src.png

This resulted in the following output,

Images/comment-out.png

Local Comments

The first two comments are local to the Bob node. This means that they will be centered on that node line.

Where the first two comments differ is the second comment has a width value in the destination node portion of the tuple. The width value is used to specify how wide to draw the comment text rectangle relative to how wide a node is on the page. So a two indicates to give the comment a width of two nodes.

If no width value is specified, then a default value of one is assumed.

Note that tying the comment width to a node width means that it varies based on the number of nodes present in a flow. The more nodes there are, the narrower the 'node width' is, and the narrower the comment width will be.

Global Comments

Now consider the second pair of comments. These comments differ from the first pair in that they have no node in the source node portion of the tuple.

These comments will be centered horizontaly on the page rather than on a specific node line. The width of a global comment is determined in the same manner as the width of a local comment.

Default Style