APIDOCJS - 在描述中添加换行
创始人
2024-09-07 12:30:26
0

要在描述中添加换行,可以使用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语法的换行符号在描述中添加了换行,使得文档更易读。请注意,在注释块中使用换行符号时,需要保持对齐,以确保文档的格式正确。

相关内容

热门资讯

透视了解!德普之星透视辅助软件... 透视了解!德普之星透视辅助软件是真的吗,wepoker免费透视脚本,线上教程(切实真的有挂);德普之...
透视辅助!aapoker辅助工... 透视辅助!aapoker辅助工具免费下载,wepoker作弊方法,曝光教程(一直有挂)1、完成aap...
透视代打!aapoker辅助器... 透视代打!aapoker辅助器是真的吗,fishpoker透视,力荐教程(原先真的是有挂);aapo...
透视神器!hhpoker怎么开... 透视神器!hhpoker怎么开透视,wpk软件是正规的吗,2025新版(总是真的是有挂)1、完成hh...
透视私人局!红龙poker透视... 透视私人局!红龙poker透视工具,wpk有辅助器吗,细节揭秘(一向存在有挂);致您一封信;亲爱红龙...
透视挂!德普之星透视辅助插件,... 透视挂!德普之星透视辅助插件,wepoker辅助透视软件,必备教程(一直真的有挂)德普之星透视辅助插...
透视辅助!wepoker透视脚... 透视辅助!wepoker透视脚本,竞技联盟透视插件,专业教程(原生存在有挂);wepoker透视脚本...
透视游戏!wpk辅助工具下载,... 透视游戏!wpk辅助工具下载,wpk软件是正规的吗,第三方教程(本来真的是有挂);wpk辅助工具下载...
透视代打!wepoker辅助器... 透视代打!wepoker辅助器是真的的吗,pokemmo修改器手机版,新版2025教程(总是是有挂)...
透视透视!hhpoker透视脚... 透视透视!hhpoker透视脚本视频,德州机器人代打脚本,透明挂教程(先前真的有挂)1、这是跨平台的...