返回具有特定属性并键入

Question

我有一个函数operation，它接受​​两个参数str（一个字符串）和fn（一个函数）。

function operation(str, fn){
  var temp = {}
  temp[str] = fn
  return temp
}

• 您如何描述此返回值？
• 这个返回值在JSDoc中是什么样的？
• 示例输出格式是什么？

这对于@return说明是否可以接受？

@returns {Object} With one key set to str and one value set to fn.

这对于@example输出是否可以接受？

operation("foo", console.log)
// => {"foo": [Function]}

我问的主要原因是因为我想使用这种格式来测试像yamadapc/jsdoctest这样的套件中的函数。

Answer 1

在我看来，你应该同时使用它们。例如，在下划线中，doc被描述为同伴：