Adding and Editing a Comment (SWC Editors)

Block Diagram Editor for SWCs

To add a comment, Closedproceed as follows.

  1. In the Basic Blocks palette or toolbar, click the Comment button.

    The Insert Comment window opens.

  2. In the text field of the Insert Comment window, enter the text for your comment.
  3. In the View Configuration area, use the combo boxes to set the comment visibility in the available views.

  4. Click OK.

    This loads the mouse cursor with the comment.

  5. Click in the drawing area to place the comment.

To edit a comment, Closedproceed as follows:

  1. To move the comment, drag it to a new position.

  2. To change the comment text or visibility, do the following:

    1. Double-click the comment.

      The Edit Comment window opens.

    2. In the text field of the Edit Comment window, change the comment text.
    3. In the View Configuration area, use the combo boxes to set the comment visibility in the available views.
    4. Click OK to close the window and accept your changes.

Note

Your settings in the View Configuration area will be used as defaults for new comments, as long as ASCET runs. The settings are not stored when you close ASCET.

If you export the view, the settings are stored in the <BasicBlockDefaults> section of the view export file.

ESDL Editor for SWCs

To add a comment, Closedproceed as follows.

  1. For a single-line comment, enter the following code:

    //<your comment>

  2. For a multi-line comment, enter the following code:

    /*<your

    multi-line

    comment>*/

  3. To add a comment after a bit of ESDL code, enter the following code:

    <ESDL code>//<your comment>

    Or

    <ESDL code>/*<your comment>*/

Note

A comment started with /* needs a closing */. If */ is missing, everything from the /* to the end of the runnable/method is treated as comment.

See also

Insert/Edit Comment Dialog Window

Automatic Documentation – Views

Automatic Documentation – Exporting Views

Automatic Documentation – Example: View Export File