IntelliJ IDEA 13.1.0 Web Help

IntelliJ IDEA provides convenient features for creating JavaDoc comments and generating project documentation.

Note

Documentation comments in your source code are available for the Quick Documentation Lookup and open for review on pressing or or or or or or or , or , or or or .

In this part:

Basics

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

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.

Note

Documentation comments in your source code are available for the Quick Documentation Lookup and open for review on pressing or or or or or or or , or , or or or .

See Also

Procedures:

Web Resources: