21.1 Comments Formatting

DVT IDE for VS Code VHDL User Guide

Rev. 24.1.7, 9 April 2024

Installation
- System Requirements
- Install DVT for VS Code from Marketplace
- Install DVT for VS Code from VSIX
- Install DVT for VS Code Using a Pre-Packed Distribution
- Set the License
User Interface
- VS Code User Interface
- DVT IDE for VS Code User Interface
  - Editor
  - Activity Bar
  - Side Bar
  - Status Bar
  - Panel
Predefined Projects
Build Configurations
- Project Natures
- Non-top files
- default.build
- Auto-config
- Simulator Log-config
- Emulating compiler invocations
- Multiple .build Files
- Compatibility Modes
  - Default DVT Compatibility Mode
  - gcc Compatibility Mode
  - ius.irun Compatibility Mode
  - ius.perspec Compatibility Mode
  - questa.vcom Compatibility Mode
  - questa.vlog Compatibility Mode
  - questa.qrun Compatibility Mode
  - vcs.vhdlan Compatibility Mode
  - vcs.vlogan Compatibility Mode
  - xcelium.xrun Compatibility Mode
- Paths
- Strings
- Comments
- Environment Variables
- Including Other Argument Files
- Build Persistence
- All Build Directives
- SystemVerilog OVM or UVM Library Compilation
- Xilinx Libraries Compilation
- Intel(Altera) Quartus Libraries Compilation
- Questa Libraries Compilation
- Use of External Programs
Compile Checks
- Compile Waivers
- Semantic Checks
- Non Standard Checks
Quick Fix Proposals
Content Assist (Autocomplete)
- Content assist for CamelCase and Underscore
- Code Templates
- Component Automatic Instantiation
- Generate Case Statement Using Autocomplete
Hyperlinks
Show Usages
Show Readers or Writers
Show Instances
Peek Exploration
Refactoring
Code Factory
Code Formatting
- Capitalization
- Whitespace
- Indentation
- Vertical Alignment
- Line Wrapping
- Disable Format for Code Sections
- Preferences Keys
Breadcrumb Navigation Bar
- Design Breadcrumb
- Verification Breadcrumb
- Scope Breadcrumb
Diagrams
- Design Diagrams
- Bit Field Diagrams
- WaveDrom Timing Diagrams
- Common Diagram Actions
- Common Diagram Toolbar
Syntax Coloring
Inactive Generates Code Highlight
Database Out of Sync Notification
> Tooltips
- > Comments Formatting
  - Javadoc
  - Natural Docs
Workspace Symbols
Views
- Problems View
- Outline View
- Compiled Files View
- Compile Order View
  - Build Config Hierarchy
- Design Hierarchy View
- Diagnostics View
Quick Search in Views
- CamelCase
- Simple Regex
- Hierarchical Search
- Search for Members
- Search Port in Design Hierarchy
Content Filters
- Content Filters XML Syntax
- Filtering by Element Type
- Content Filters Examples
- Predefined Content Filters
External Tools Integration
Scripts
- dvt_code.sh
  - dvt_code.sh Syntax
  - dvt_code.sh Examples
- dvt_ls.sh
  - dvt_ls.sh Syntax
  - dvt_ls.sh Examples
Custom Scripts
SCM Checkout Hook
Memory Monitor
Application Notes
- Flow Integration
- Environment Variables
- Design Elaboration
- FPGA Support
  - Intel(Altera) Quartus
    - Intel(Altera) Quartus Libraries Compilation
  - Xilinx ISE/Vivado
    - Xilinx Libraries Compilation
- Output and logging
Handy VS Code Documentation Pointers
What is New?
How to Report an Issue?
Legal Notices
Third Party Licenses
Q & A
- Can I deactivate DVT support for a workspace even though one of my workspace folders contains a .dvt directory?

21.1 Comments Formatting

Table of Contents

21.1.1. Javadoc
21.1.2. Natural Docs

DVT automatically selects between Javadoc and Natural Docs for each comment based on the syntax. If no syntax is detected, the comment will be rendered as it is.

Prev Home Next Up