@apiParam在apiDoc中的用法

@apiParam是apiDoc中用于定义接口参数的注释标记。它用于描述接口的请求参数，包括请求方法、路径、参数类型、参数名、参数说明等信息。

@apiParam可以用在接口的注释块中，通过以下格式进行使用：

/**
 * @api {请求方法} /路径
 * @apiParam {参数类型} 参数名 参数说明
 */

具体参数说明如下：

• 请求方法：表示接口的请求方法，常见的有GET、POST、PUT、DELETE等。
• 路径：表示接口的路径，即接口的URL。
• 参数类型：表示参数的数据类型，如String、Number、Object等。
• 参数名：表示参数的名称。
• 参数说明：表示参数的描述信息，可以包括参数的作用、取值范围、必选或可选等。

例如，以下是一个使用@apiParam的示例：

/**
 * @api {POST} /user/login
 * @apiParam {String} username 用户名
 * @apiParam {String} password 密码
 */

在以上示例中，使用@apiParam定义了一个POST请求方法，路径为/user/login的接口。该接口需要两个参数：username和password，它们的类型都为String。