文档注释

各类标签@param, @method等请参考usejsdoc和JSDoc Guide；

建议在以下情况下使用：

  • 所有常量
  • 所有函数
  • 所有类
  1. /**
  2.  * @func
  3.  * @desc 一个带参数的函数
  4.  * @param {string} a - 参数a
  5.  * @param {number} b=1 - 参数b默认值为1
  6.  * @param {string} c=1 - 参数c有两种支持的取值</br>1—表示x</br>2—表示xx
  7.  * @param {object} d - 参数d为一个对象
  8.  * @param {string} d.e - 参数d的e属性
  9.  * @param {string} d.f - 参数d的f属性
  10.  * @param {object[]} g - 参数g为一个对象数组
  11.  * @param {string} g.h - 参数g数组中一项的h属性
  12.  * @param {string} g.i - 参数g数组中一项的i属性
  13.  * @param {string} [j] - 参数j是一个可选参数
  14.  */
  15. function foo(a, b, c, d, g, j) {
  16.     ...
  17. }