DVT IDE for VS Code VHDL User Guide
Rev. 22.1.36, 22 November 2022

18.1.1 Javadoc

Comments written in Javadoc will be formatted based on the following tags:

  • @author

  • @link

As links you can have: an object name, a file, a valid web URL. If you Ctrl + right click on a link that contains an object name, it should jump to its declaration.

  • @param

  • @return

  • @see

Works similar to @link, but it will be placed in a separate section at the bottom of the comment, named "See".

  • @since

  • @version