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很难阅读和维护。并非所有行为都可以记录。

并非所有人都能正确理解本文档。有些人会尝试根据自己的风格更改文档。

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

2 个答案: