Skip to content

Introduction to the use of javadoc tag

shalousun edited this page Nov 3, 2019 · 1 revision

The original intention of smart-doc is to remove the annotation intrusion by using javadoc document comments. Therefore, each function of smart-doc is first to consider the javadoc native tag. The following is an introduction to some javadoc tags used by smart-doc.

tag description
@param In the Spring Boot Controller, parameters for Java primitive types must be described using @param tag and write comments, and for Entity type smart-doc will not be checked
@apiNote @apiNote is a new document tag for java. Smart-doc uses @apiNote's comment as a detailed description of the method. If a method does not write @apiNote comment, smart-doc directly uses the method default comment padding