我们如何使用 jsddoc 记录作为参数作为函数传入的回调 return 值

Question

我目前使用当前的 jsdoc 语法记录了一个 javascript 函数和其他代码（我欢迎更改）

function exportStuff(dataObject) {
  /**
   *
   *  @param {Object} dataObject - some details about it
   *  @param {function} dataObject.animationStart
   *  @param {function} dataObject.ajax - when invoked, returns a promise/.thenable, but I want to know how to state that it does here in the jsdoc
   *  what if I tried:
   *  @callback {function} dataObject.ajax (not sure how to embed @param and @return here)
   *
   */

}

https://jsdoc.app/tags-callback.html 对我来说没有多大意义......但是在更多地看之后......也许他们的意思是在他们的例子中将参数类型定义为 @param {requestCallback} 然后稍后作为一个单独的注释，我们需要定义 @callback requestCallback 并记录 @param 和 @returns 用于定义

我的问题有点不同，因为我想使用 jsdoc 样式，但也知道如何在一个地方内联所有内容（不分开）传入函数的参数和 returns 类型用作回调（抱歉重复）

感谢您的宝贵时间！

干杯

Answer 1

function 类型的工作方式如下：

function({paramTypes}):returnType

例如；

一个事件处理程序，returns 什么都没有；

@param {function({Event}):void}

标准sum方法：

@param {function({number}, {number}):number}

预期的 this 类型可以指定为：

@param {function(this:Foo):void}

new 类型的结果可以指定为：

@param {function(new:Foo):void}

也可以分散操作：

@param {function(string, ...number): number}

= 可选，? 可为空：

@param {function(?string=, number=)}

-- Closure Type System.

中的 Via 类型

我们如何使用 jsddoc 记录作为参数作为函数传入的回调 return 值

How do we use jsddoc to document a callbacks return value that is passed in as a parameter as a function

javascript

syntax

comments

jsdoc