Javascript 在JSDoc中将对象数组记录为回调函数的参数

callback.rows

是具有多个重复字段的任意长度数组

如何在

JSDoc

中记录每个字段（类型、属性、描述）

有可能应用这个吗

或者可以接受该解决方案：

/**
* 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
}

尝试：

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

请注意，您可以将任何类型放在那里，而不仅仅是字符串。。。比如

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

正如我提到的，最好的代码文档是单元测试

在

JSDoc

中，应仅记录主要参数。即

回调

是

函数

。最后3行应该移到单元测试中

这种文档艺术更易于维护和证明

大量的

JSDoc

s很难阅读和维护。并不是所有的行为都能被记录下来

并非所有人都能正确理解此文档。

---

有些人会尝试根据自己的风格更改文档。

我总是在描述中写入回调参数。谁看了这些文件：）？第二种选择对我来说没问题