javascript - 跨多种方法记录相同的 jsduck 配置类型

Question

两个问题:

首先，有人知道如何继承某些文档的部分内容吗？特别是对于“选项”对象:

 * @param {Object}          opts
 * @param {String}          opts.effect    Transition effect.  fade|slide
 * @param {String}          opts.direction Direction to do the transition, when applicable.  up|down|left|right
 * @param {String|Number}   opts.duration  Transition duration in ms, or one of short|long
 * @param {String|Function} opts.timing    Transition timing function, or one of

基本上，我想要多个方法中的文档，但我不想将其复制到每个方法，并且我想要一个公共(public)位置来更改它。

第二，如果我可以通过某种方式继承文档，我可以扩展它吗？例如我想要:

method foo:
    opts.opt-a // inherited
    opts.opt-b // inherited
    opts.opt-c // inherited
    opts.opt-d // local to this method

Answer 1

不支持这种继承。

您可以做的就是将此选项对象记录为仅文档类:

/**
 * @class FooOpts
 * A configuration object for Foo, instantiated with object literal.
 */
/** @cfg {String} effect */
/** @cfg {String} direction */
/** @cfg {String|Number} duration */
/** @cfg {String|Function} timing */

然后使用这个仅文档类作为您的参数类型:

* @param {FooOpts} opts Config object for the FooOpts class.

要覆盖这些选项，您可以定义一个子类。

根据您拥有的选项数量，这种方法的开销可能不合理。但也许您在多个地方指定相同的选项这一事实表明您确实最好为它们创建一个实际的具体类。