如何在 jsdoc 中記錄數組元素？

Question

我有一個 function ，它返回一個包含兩個元素的數組。 對於給定的評論，VS code Intellisense 工作正常，但是當我使用 jsdoc 生成文檔時，它會引發錯誤。

ERROR: Unable to parse a tag's type expression for source file... with tag title "returns" and text "{[state: initialState, dispatch: Function]}.

/** 
 * @typedef {object} initialState
 * @property {string} locator_id - ID 
 * @property {boolean} loading - 
*/

/**
 * @namespace Context
 * 
 * @returns {[state: initialState, dispatch: Function]} 
 */

Answer 1

您可以使用：

 /** @typedef AR_INNERJOIN @type {Set} @property {string} Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras at feugiat enim, eu mattis turpis. Duis suscipit, libero eu sagittis faucibus, velit urna pulvinar ex, sit amet sollicitudin leo dui in arcu. */ /** * sample inner join set * @type {AR_INNERJOIN} */ this.internalConnections = new Set();

Answer 2

object 數組的 JSDoc 語法為：

/**
 * Description here...
 * @returns {Array.<{state: initialState, dispatch: Function}>}
 */