如何记录参数对象的函数定义答案

【问题标题】：How to documenting an argument object's function definition如何记录参数对象的函数定义
【发布时间】：2017-11-16 11:05:37
【问题描述】：

当一个类的参数是一个包含函数属性的属性时，我如何记录该参数（哇哦）。

例子：

class MyClass {
    /**
     * @param {Object} options - configuration for the class
     * @param {Function} options.onSuccess - a callback function which has two arguments A and B
     * @memberof MyClass
     */
    constructor(options) {...}
}

我如何定义某人应该像这样使用此类，其中 onSuccess 传递两个参数 A 和 B（其中 A 可能是具有其他属性的对象等）

var instance = new MyClass({
    onSuccess: (A, B) => {...}
});

我正在使用 Visual Studio Code，但它显示未找到定义。这是可能的还是它的层次太深了？

【问题讨论】：

我的回答有帮助吗？

标签： javascript visual-studio jsdoc

【解决方案1】：

我不确定a 和b 的类型是什么，或者函数是否返回void。但这里有一些选择：

interface MyClassArgs {
    onSuccess: (a, b) => void;
}

class MyClass {
    constructor(options: MyClassArgs) { }
}

或者

class MyClass {
    constructor(options: { onSuccess: (a, b) => void }) { }
}

【讨论】：