DVT SystemVerilog IDE User Guide
Rev. 19.1.28, 14 August 2019

40.4.1 Hyperlinks in Comments

You can define hyperlinks in comments using the @link or @see pragmas, for example:

// @link uvm_pkg::run_test
// For more details @see spi_if.miso and @see spi_if.mosi

Hover the hierarchical id specified after the pragma with the mouse cursor while holding down the Ctrl key, and click to go to the element's declaration. Alternatively, place the editor cursor on the hierarchical id and press F3

The hierarchical identifier following @link or @see is of the form:

[<package_name>::<type_name>.<inner_type_name>.]<element_name>

where <element_name> must be a type (class, struct, module, entity, interface, etc.) or a type member (method, field, event, signal, port etc.).

Examples:

@link <element_name>

@link <type_name>.<element_name>

@link <type_name>.<inner_type_name>.<element_name>

@link <package_name>::<type_name>.<element_name>

Note: If <path.to.element> does not solve to a unique element in code, a list of navigation options is displayed.