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

相关内容

热门资讯

科技分享!最新版wpk(wep... 1、科技分享!最新版wpk(wepoker)外挂透明挂辅助工具(透视)黑科技教程(有挂方法)-哔哩哔...
必备科技(德州nzt)外挂透明... 必备科技(德州nzt)外挂透明挂辅助挂(透视)辅助透视(有挂解惑)-哔哩哔哩是一款可以让一直输的玩家...
七分钟了解(德州之星手游)外挂... 七分钟了解(德州之星手游)外挂透明挂辅助挂(辅助挂)竟然真的有挂(2024已更新)(哔哩哔哩);原来...
最新通报(最新版wpk)外挂透... 1、最新通报(最新版wpk)外挂透明挂辅助插件(透视)发牌规律(有挂透视)-哔哩哔哩(UU poke...
1分钟了解!cloudpoke... 1分钟了解!cloudpoker云扑克(wepoKE)外挂透明挂辅助软件(透视)我来教教你(有挂神器...
热点讨论(WEPoke)外挂透... 《WEPoke软件透明挂》是一款多人竞技的WEPoke辅助透视游戏,你将微扑克对手来到同一个战场,为...
玩家科普(眯眯扑克)外挂透明挂... 这是一款非常优秀的眯眯扑克 ia辅助检测软件,能够让你了解到眯眯扑克中牌率当中全部隐藏参数,与同类眯...
重要通知(wpk机制)外挂透明... 此外,数据分析德州(wpk机制)辅助神器app还具备辅助透视行为开挂功能,通过对客户wpk机制透明挂...
揭秘真相!扑克世界(wepoK... 揭秘真相!扑克世界(wepoKe)外挂透明挂辅助挂(辅助挂)扑克教程(有挂猫腻)-哔哩哔哩;原来确实...
透明了解(wePOke)外挂透... 1、透明了解(wePOke)外挂透明挂辅助脚本(辅助挂)辅助透视(有挂秘诀)-哔哩哔哩;详细教程。2...