在JSDoc中將對象數組記錄爲回調函數的參數

Question

callback.rows是具有多個重複字段的任意長度的數組。

如何在JSDoc中記錄每個字段（類型，屬性，說明）？

有沒有可能應用此method？

或可能是該解決方案可以接受：

/** 
* Get list of all documents 
* @param {Function} callback      Standard callback function 
* @param {Error} callback.err     Error object if any 
* @param {Array} callback.rows     Rows list 
* @param {String} callback.rows[0].field1  field1 
*/ 
var myFunc = function (callback) { 
    // Function body 
} 

Answer 1

嘗試：

/**@param {string[]} callback.rows*/

請注意，你可以把任何類型的存在，不僅僅是串...如

/**@param {{field1: string}[]} callback.rows */

Answer 2

正如我提到的你的代碼最好的文檔是單元測試。

在JSDoc應該只有主要參數記錄。即callback是Function。最後3行應該移到你的單元測試中。

本文檔的文檔更多可維護和可證明。

廣泛JSDoc s爲難以閱讀和保持。並非所有行爲都可以被記錄。

並非所有人都能正確理解本文檔。有些人會嘗試根據自己的口味改變文檔。