要在描述中添加换行,可以使用Markdown语法中的换行符号,即两个空格和一个换行符号。
以下是一个使用APIDOCJS生成API文档的示例,包含了在描述中添加换行的代码:
/**
* @api {get} /user/:id 获取用户信息
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id 用户ID
*
* @apiSuccess {String} name 用户名
* @apiSuccess {String} email 邮箱地址
* @apiSuccess {String} bio 个人简介
*/
/**
* @api {post} /user 创建用户
* @apiName CreateUser
* @apiGroup User
*
* @apiParam {String} name 用户名
* @apiParam {String} email 邮箱地址
* @apiParam {String} bio 个人简介
*
* @apiSuccess {Number} id 用户ID
* @apiSuccess {String} message 创建成功提示信息
*/
在上述示例中,我们使用Markdown语法的换行符号在描述中添加了换行,使得文档更易读。请注意,在注释块中使用换行符号时,需要保持对齐,以确保文档的格式正确。
上一篇:apidoc不排除排除模式