Description = #doc{ }

With this annotation, you can specify documentation style details about a part, record or variable by specifying the description property. When content assist is available, these descriptions are used and displayed to you. These documentation details are stored in the IR binary and will also be included in any EGLAR that contains the binary.

You could either specify a simple string value enclosed in quotation marks, or a more detailed description within the #doc { } if the value spans more than one line or contains new line characters.

description = "This is my program part"

or

description = #doc { This is my text for this program part. The program part description is carried forward to this second line and also to this third line.}

The value is displayed using an HTML parser, which means that many of the standard HTML tags can be used to format the text. For example, you can place the HTML tags around parts of the text value to make some of the text bold, or create lists, or new lines, etc.


Feedback