将对象数组记录为JSDoc中回调函数的参数
将对象数组记录为JSDoc中回调函数的参数
提问于 2014-11-24 15:39:39
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
}回答 2
Stack Overflow用户
回答已采纳
发布于 2014-11-24 18:14:23
尝试：
/**@param {string[]} callback.rows*/
注意，你可以把任何类型放在那里，而不仅仅是字符串.比如
/**@param {{field1: string}[]} callback.rows */
Stack Overflow用户
发布于 2015-02-06 08:11:26
正如我提到的，代码的最佳文档是单元测试。
在JSDoc中，应该只记录主要参数。也就是说，callback是Function。最后3行应该移到单元测试中。
这种文档技术更多的是可维护的和可证明的。
扩展的JSDoc很难阅读，维护。并不是所有的行为都能被记录下来。
并不是所有的人都能正确地理解这些文档。有些人会尝试根据自己的口味修改文档。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/27108517
复制相关文章
相似问题
腾讯云开发者
