Adding Comments to Block Designs - 2021.2 English

Vivado Design Suite User Guide: Designing IP Subsystems Using IP Integrator

Document ID
Release Date
2021.2 English

You can add comments anywhere in the BD.

  1. Right-click anywhere in the BD and select Create Comment.

    This creates a comment box where you can type comments:

    The corresponding Tcl commands are as follows:

     set_property USER_COMMENTS.comment_0 {}  [current_bd_design]
     set_property USER_COMMENTS.comment_0 {Enter Comments here}  [current_bd_design]
     set_property USER_COMMENTS.comment_0 {My Design}  [current_bd_design]
  2. Drag and place these comment boxes at any location on the BD canvas.
    These types of “un-anchored” comments are written out at the top of the generated HDL code, as shown in the following figure.

You can also add comments to pins of an IP or to I/O ports in the BD:

  1. With the pin or port selected, right-click and select Create Comment, as shown in the following figure.

  2. In the text box that is created, type your comments.
    This text box can be seen in the GUI as anchored to the pin or port in question, as shown in the following figure.

    The generated HDL code contains the comments for that particular pin or port, as shown in the following figure.

You can add comments to either pins/ports or interface pins/ports in the GUI. Comments for the pins/ports are written out in the generated HDL. However, comments for interface pins/ports do not appear in generated HDL code.