Specification for JSDoc annotations

Comments start with/** */end

JSDOC Command Properties

Command name Description

@param

@argument Specify the parameter name and description to describe a function parameter.

@return

@returns describes the return value of a function.

@author Indicates the author of the Code.

　@see Create an HTML link that points to the description of the specified class.

@version Specify the release version.

@requires Create an HTML link that points to the specified class that the class requires.

@throws

@exception describes the type of exception that a function might throw.

{@link} creates an HTML link that points to the specified class. This is similar to @see, but {@link} can be embedded in the comment text.

@author Indicates the author of the Code. (Translator Note: This mark has appeared before, it is recommended to remove)

@fileoverview This is a special token, if you use this tag in the first document block of a file, specify that the remainder of the document block will be used to provide an overview of the file.

@class provides information about the class, which is used in the document of the constructor.

@constructor explicitly that a function is a constructor for a class.

@type Specifies the return type of the function.

@extends indicates that a class derives from another class. This information is usually detected by JSDoc itself, but in some cases this tag must be used.

@private indicates that a class or function is private. Private classes and functions do not appear in HTML documents unless the-private command-line option is available when you run JSDoc.

@final indicates that a value is a constant value. Remember that JavaScript cannot really guarantee that a value is a constant.

@ignore JSDoc will ignore the function with this tag.