0

我有一个带有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这样的套件中的功能。

4

1 回答 1

0

在我看来,你应该同时使用它们。例如,在 underscorejs 中,doc 被描述为 Fellow: 在此处输入图像描述

于 2015-07-30T02:46:37.227 回答