APIDOCJS - 在描述中添加换行
创始人
2024-09-07 12:31:00
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语法的换行符号在描述中添加了换行，使得文档更易读。请注意，在注释块中使用换行符号时，需要保持对齐，以确保文档的格式正确。
上一篇：apidoc不排除排除模式
相关内容
热门资讯
前端-session、jwt
目录： （1）session （2&#x...
linux入门---制作进度条
了解缓冲区 我们首先来看看下面的操作： 我们首先创建了一个文件并在这个文件里面添加了...
关于测试，我发现了哪些新大陆
关于测试 平常也只是听说过一些关于测试的术语，但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法
1. 前缀和 假设有一个数组，我们想大量频繁的去访问L到R这个区间的和，...
nodejs：本地安装nvm实...
一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本，node...
JAVA集合知识整理
Java集合知识整理 HashMap相关 HashMap的底层数据结构：jdk1.8之...
无刷直流电机介绍及单片机控制实...
无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2
1.传纸条 AcWing 275. 传纸条 - AcWing 走两条路，走一条最大的...
常用的DOS命令
常用的DOS命令 DOS（Disk Operating System，磁...
＜C++＞ 类和对象(下)
1.const成员函数将const修饰的“成员函数”称之为const成员函数，cons...