Comments Formatting

Comment formatting preferences allow you change how comments are rendered in tooltips.

You can choose the markup language used to render the comments from: Window > Preferences > DVT > Editors.

Available options are: Javadoc, Natural Docs, Verbatim and Autodetect.

Javadoc: Comments are always rendered using Javadoc markup language.
Natural Docs: Comments are rendered using Natural Docs markup language.
Verbatim: Comments are rendered as they are.
Autodetect: Automatically selects between Javadoc and Natural Docs for each comment based on the syntax. If no syntax is detected, the comment will be rendered Verbatim.

Note

Comments using both markup languages are not supported, they will be rendered using one of the markup languages.

Javadoc

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

Tag Name	Comment	Tooltip Window	Notes
Author
Link			`{@link object_name label}` As links you can have an object name. If you Ctrl + right click on a link, it will jump to its declaration.
Param
Return
See			`@see object_name label` `@see <a href=URL>label</a>` 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 will jump to its declaration. Everything you link with @see tag will be placed in a separate section at the bottom of the comment, named “See also”.
Since
Version

It’s similar to Specador documentation for Javadoc that you can check out right here.

Comments written in Natural Docs will be formatted based on the following syntax:

Tag Name	Comment	Tooltip Window	Notes
Bold Font
Bullet List
Definition List
Heading			If the markup language preference is set to “Autodetect”, you must include another Natural Docs specific syntax in order to activate the Natural Docs formatter on this pattern.
Image			The path can be either absolute, relative to the current file or relative to additional image locations. To specify additional image locations use `+dvt_natural_docs_image_locations` directive.
Italic Font
Line Syntax			If the markup language preference is set to “Autodetect”, you must include another Natural Docs specific syntax in order to activate the Natural Docs formatter on this pattern.
Link			`<label: URL>` `<label at URL>` As links you can have: an object name, a file or a valid web URL. If you Ctrl + right click on a link that contains an object name, it will jump to its declaration.
Start Code
Topic Line
Underline Font