什么是JsDoc，請移步
接下來我們來看常用的jsDoc規(guī)范

注釋符

/**
*
*
*/

關鍵字說明
@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
}