IntelliJ IDEA 2016.2 Help

Documenting Source Code in IntelliJ IDEA

In this part:


IntelliJ IDEA provides convenient features for creating documentation comments.

Documentation comments in your source code are available for the Quick Documentation Lookup and open for review on pressing Ctrl+Q.

In Java files, IntelliJ IDEA creates stubs of documentation comments on typing the opening tag and pressing Enter.

Documentation comments can be created in accordance with the RDoc or YARD syntax.

If this feature applies to the methods, @param tags are created for each parameter declared in the method signature, @return tag is created if the method is not void, and @throws tags are created for each exception statement.

When you create additional tags, IntelliJ IDEA provides code completion that suggests the possible tag names.

If a certain tag has multiple values, the same code completion provides the list of available values. Smart type code completion suggests the list of classes that are appropriate for the specific exception.

See Also

Last modified: 5 September 2016