Question

如何记录退货内的功能？在这个例子中，我需要（）记录。我已经尝试添加@memberOf和@name来生成它。似乎没有什么对我有用。

/**
 * The description for the outer function 
 * @param {string} test Example argument
 * @return {Object}
 */
example.func = function(test) {
   return {
       /**
        * The description for the inner "then" function
        * @param {Function} cb The callback function
        */
       then: function(cb) { }
   }
}

更新在顶部添加了JSDoc注释以防止混淆。

Answer 1

JSDoc comments必须高于声明，return语句必须使用@returns {type} value声明（请注意@return是同义词）

/**
 * Returns the sum of a and b
 *
 * @param {Number} a
 * @param {Number} [b = 0]
 * @returns {Number}
 */
function sum(a, b = 0) {
    return a + b;
}

如何记录退货内的功能？

1 个答案: