JsDoc常用注释规范

什么是JsDoc，请移步
接下来我们来看常用的jsDoc规范

注释符

/**
*
*
*/

关键字说明
@file ：写在文件开头，用于描述当前文件
@desc: 用于描述当前文件或者代码
@author：当前文件的作者
@copyright： 当前文件的版权信息
@license 文件许可证
@version 版本号
@since 描述某个功能自哪个版本开始支持
@see '另见'
@todo 接下来准备做的事情
@function/@func/@method 描述一个函数
@param 描述参数信息
@return 描述返回值
@callback 描述回调函数
例子

// utils.js
/**
* @file 这是工具库文件，提供通用的方法
* @version 0.0.1
* @todo 英文字母和数字的对应关系的方法
* @author chxu
/*


/**
* @param {obj} item 一个对象
* @return {string} key 返回值是字符串
* @see setValue
* @desc 根据key获取对应的值
*/

function getValue (item, key) {
    return item[key]
}

/**
* @param {string}  [value] [xx]表示xx是可选参数
*/
function setValue (key, value, item) {
  // do something
}