Generate document comments with IDEA

Annotate templates with documentation

The function is to fix annotations without having to write them by hand every time, reducing the workload.

Class and interface annotations

In Settings, search for File and Code Templates, as shown in the following figure.

2. Method annotation

See article

Customize JavaDoc tags

The function is to customize personality tags that JavaDoc automatically recognizes in the documentation. The principle is the -tag parameter of the Javadoc command.

Add method: Alt +Enter on custom tags and add to Custom Tags.

To delete a custom label, perform the following operations:

3. Generate documentation

In the upper column of Idea, locate Tools and open Generate JavaDoc in the menu

Reference: The official website of IDEA describes the notes in the document