文档注释

在开发过程中，我们会将一些函数进行封装，而为了使日后调用这些函数的时候能更好的清楚所调用函数的参数、返回值、作用等信息，我们需要对其进行文档注释。

认识文档注释

文档注释说白了就是注释的一种，平常我们会为一些代码段进行注释来表明这段代码的作用。而文档注释则是为了让我们对某些封装的函数一目了然。

普通的单行注释

// 单行注释

多行注释

/**
* 多行注释
*/

文档注释

文档注释由以下JsDoc标签组成

@param 参数注释

使用@param注释来表示当前的函数或类的方法的参数。通常是由 @param + { 参数类型 } + 参数名 + 参数说明 组成

/**
 * 网络请求
 * @param { object } options 配置对象
 * @param { string } options.url 请求地址
 * @param { 'GET' | 'POST'} options.method 请求方式
 * @param { object } options.body 请求体
 * @param { object } options.headers 请求头
 * @return { Promise } 返回结果
 * @example
 * request(options) // 返回Promise，使用then或catch得到返回结果
 */
function request(options){
    ...
}