Question

如果可以混合参数类型，如何使用 JSDoc 在JavaScript中记录方法？

我在Dialog对象上有方法，可以显示HTML或我自己的Viewable对象。 JSDoc方法如下所示：

/**
 * Can pass in viewable object, or some HTML element
 *
 * @param viewable viewable {Viewable} or HTML element {HTMLElement} or String {string}
 * @param {Boolean} cancelable is cancellable
 * @param title string or data object of String and Id {Title:String, Id:String} for setting HTML id value
 * @param {Array} actions array of functions actions display buttons on the bottom connecting to the passed in functions
 * @param {String} size mode. Can be mini,small,medium,large,maxi. Or of type {width:number, height:number}
 * @param {Number} zindex starting z-order. Note: first level dialog = 10,11,12, second level dialog 13,14,15 etc.
 */
Dialog.showElement = function(viewable, cancelable, title, actions, mode, zindex){
..
}

因为JS不允许方法重载，所以我需要创建这些类型的方法，其中方法中的参数可以是两种不同的类型。有没有办法在JSDoc中记录这个，或者JSDoc只允许你用一种类型记录一个param？

另外，您如何记录{Title:String, Id:String}类型的参数？也就是说，传入的对象不属于某种类型。准，一个JSON对象。

Answer 1

您可以使用|分隔符在方法类型签名中指定多个类型：

/**
 * Some method
 * @param {Object|string|number} param The parameter.
 * @returns {Object|string|number} The modified param.
 */
function doSomething(param) {
    return etc..
};

Answer 2

Google Closure Compiler Docs推荐以下表格 - 看起来是正式的，因为它与usejsdoc.org上的相同：

/**
 * Some method
 * @param {(Object|string|number)} param The parameter.
 * @returns {(Object|undefined)} The modified param.
 */
function doSomething(param) {
    return etc..
};

引用上面链接的闭包编译器文档：

请注意括号，这是必需的。

如何使用混合参数类型记录JSDoc？

2 个答案: