VHDL and Verilog for Visual Studio

Documentation

V3S | Coding | Quickinfo/Tooltip


Support

  VHDL
  Verilog

How to Access

Default Shortcut: Ctrl+K+I
Mouse-hover in code-editor window

Description

Useful information (e.g., type, default value, location, etc.) of the underlying item are displayed.

Documentation

Hovering the mouse over any identifier brings up a quickinfo/tooltip window. This window contains the most important information concerning the respective symbol. Some of the information shown can be configured in Preferences|VHDL|Basics|Quickinfo. Notice that there are several different types of symbols over which the mouse can hover.

Preferences for Quickinfo/Tooltip

Show location, file and library of symbols. If enabled, the full location of the symbol defintion is included in the tooltip window.
Resolve type and alias definitions If enabled, non-primitive type definitons (e.g., arrays, subtypes, etc.) are fully resolved until a primitive data type is reached. This way, the full type information can be retrieved from the tooltip.
Resolve standard type definitions (std_logic_vector, std_ulogic, etc) If enabled, also default types such as std_logic_vector (which is an array type), are also resolved until a primitive data type is found
Show parent container for symbols (e.g., units, record fields, ports, enums) Some symbols are part of a parent module. For example, a state is part of an enumeration data type, or a time unit is part of the respective time unit data type. If enabled, these containers are also shown in the tooltip for your convenience.

Depending on the symbol (e.g., signal, constant, component, etc.) different information will be presented. The below table provides some examples with a short description. Please notice that this table does not in any way cover all different aspects of the quickinfo features, it shall only provide a course overview.

Tooltip for a Constant. Notice the default value, and the comment on the very right where the constant's actual value is derived (whereever possible). See also   Expression Evaluator.
Tooltip for an Enumeration-literal. The type is resolved and shown in the tooltip.
Tooltip for an overloaded Function. The signatures of all overloads are shown. Notice that in this example the 'Show location, file and library of symbols' setting was disabled for improved readability.
Tooltip for a Datatype. Notice that the type is fully resolved, so every bit of information concerning this type is shown in the tooltip. This is especially usefull for non-standard data types.
Tooltip for a Signal. Notice that also the signal's datatype is shown (and resolved if necessary).
Tooltip for an Attribute. Notice that for standard VHDL attributes, there is some short documentation included in the tooltip.
© 2013 - 2017 by ViDE-Software Contact | Terms | Imprint