Comment Icon Properties

→

Stand-alone comments can be added to macros with the Comment icon to make the code easier to understand.

Old Versions

This page is current for Flowcode v11 and later. Earlier versions can be found below:

Flowcode v10

Flowcode v9

Flowcode v8

Details

Drag the icon to where you want it and add your comments in the icons property box.

Comments allow users to leave notes in their code explaining functions, explaining variable settings etc., or for any other documentation task that they feel is needed.

Leaving comments is a good idea as it helps others understand your code, but they should be accurate and up-to-date because otherwise the comments could be misleading.

Further Info

Each individual command icon in Flowcode can have its own comment (the "Display Name"), so this Comment icon is best used to provide additional detail for a section of code.

Comments that include "TODO:" will be automatically added to the TODO List, providing a convenient way method to list uncompleted parts of a project.

There is a separate comment icon - - that can be added to State Diagrams

Commenting code is not essential, and the use of well-named variables and macros can be more important to make your program easy to understand.

Video

The Comment icon video shows how comments can be used in your programs.