函数注释
函数注释,一方面提高了可读性,另一方面还可以生成在线文档。
一个高质量的函数,注释少不了,但是这并不代表所有的函数都需要注释。富有富的活法,穷有穷的潇洒,重要或者复杂的函数,可以写个好注释;简单或者不重要的函数,可以不写注释或者写一个简单的注释。
那么,目前函数的注释都有哪几种方式呢? 一般分为普通函数和构造函数。
(1)普通函数注释:
/**
* add
* @param {Number} a - 数字
* @param {Number} b - 数字
* @returns {Number} result - 两个整数之和
*/ function add(a, b) { // FIXME: 这里要对 a, b 参数进行类型判断 let result = a + b return (result)
}
(2)构造函数注释:
class Kun { /**
* @constructor
* @param {Object} opt - 配置对象
*/ constructor(opt = {}) { // 语句注释 this.config = opt
}
}