如何在 JSDOC 中记录对象数组

2024-02-20

我有一个以对象数组作为参数的函数,并且想使用 JSDOC 描述参数(包括数组中对象的属性),如下例所示:

/**
 * @param {Array.<Object>} filter - array of filter objects
 * @param ...
 */
function doSomething(filter) {
}

其中过滤器是这样的:

filter = [
   {id: 'session', value: 1},
   {id: 'name', value: 'john'}
]

我将如何记录属性id and value在 jsdoc3 中?


像这样:

/**
 * @param {Object[]} filter - a list of literal filter objects
 * @param {string} filter[].id -  id to filter against...
 * @param {string|number} filter[].value - value to filter for...
 */
function doSomething(filter) {
    // do stuff
}

取自http://usejsdoc.org/tags-param.html http://usejsdoc.org/tags-param.html

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何在 JSDOC 中记录对象数组 的相关文章

随机推荐

  • Flutter调试release模式,release模式下启用日志

    根据文档我知道 调试信息被删除 调试已禁用 但是我们可以以某种方式强制打印日志 或者在发布模式下进行调试吗 生产应用程序 我正在使用 Android Studio 例如 在 AS 中开发 Android 应用程序时 我们可以打印日志 and
  • PHP lambda 函数和范围

    下面的函数接受一个数组并检查其键和值是否与指定的数据类型匹配 我似乎对之前工作的内部 lambda 函数遇到了一些问题 我正在运行 PHP v5 3 6 他们最后在 v5 3 4 下工作 他们抱怨未传递的变量不在范围内 如果我将该变量重述为
  • 如何使用 uiview 和 uibutton 检测对 Uitableview 单元格的点击?

    我创建了一个表视图 并将自定义 uiview 添加到单元格的内容视图中 uiview 有一个 uibutton 但是 我可以在创建单元格时将 uibutton 添加到内容视图中 我想获取桌面视图上的点击事件来执行某些操作 我还希望 uibu
  • 如何映射或嵌套 Python 2.7 函数生成器?

    如果我在 Python 2 7 中有一个非常简单 尽管可能非常复杂 的函数生成器 如下所示 def accumulator x yield 0 while True x yield x 可以这样使用 gt gt gt a accumulat
  • 如何在firebird sql语句中使用非ascii字符串文字?

    我想在 firebird sql 查询中使用非 ascii 字符串文字 所以我用了火焰知更鸟首先看看它是否有效 我用过这样的东西 SELECT NAME FROM TABLE1 WHERE NAME 我也尝试过 SELECT NAME FR
  • 在 C++ 中传递变量“名称”

    我目前仅使用以下模板作为检查 NULL 指针的方法 如果为 NULL 则将错误消息打印到日志文件 然后返回 false template lt typename T gt static bool isnull T t std string
  • 关于“Hello World”Android 教程的菜鸟问题

    刚刚开始学习 Android 开发和 Java 所以 这是我正在使用的代码 package com example helloandroid import android app Activity import android os Bun
  • 如何让 Eclipse 运行我的所有 Groovy 单元测试?

    我有一个 Eclipse 项目 其中有许多用 Groovy 编写的单元测试 我可以使用 Eclipse 的 GUnit 运行配置在每个单独的类中运行测试 我打开此配置 选择 运行单个测试 单选按钮 然后选择我要运行其测试的类 这工作正常 但
  • Doxygen 速度慢

    Doxygen 在我们的代码库上运行大约需要 12 小时 这主要是因为有大量代码需要处理 约 150 万行 然而 我们很快就无法进行夜间文档更新 因为它们花费的时间太长 我们已经不得不减少图表深度以将其缩短至 12 小时 我已经尝试过标准方
  • 如何在nodejs中将UUID存储为字母数字

    Node uuid提供了一个优秀的包来生成uuid https github com broofa node uuid https github com broofa node uuid Generate a v4 random id uu
  • 是否可以提交一系列不同的工作来进行 slurm ?

    例如 我有一个名为myScript那个过程one输入文件 我有一个文件名列表 也就是说 我需要运行 myScript
  • 我可以在每次除法发生时禁用检查零除法吗?

    为了更好地理解 Rust 的恐慌 异常机制 我编写了以下代码 feature libc extern crate libc fn main let mut x i32 unsafe x libc getchar let y x 65 pri
  • Coqide 错误:编译的库 Basics.vo 对库做出了不一致的假设

    我在 mac os X 上使用 CoqIDE 8 4pl5 当 CoqIDE 转发到此命令时 会弹出此错误消息 需要导入基础知识 错误 编译的库 Basics vo 对库做出了不一致的假设 Coq Init Notifications 当我
  • 从 NHibernate 映射文件生成 C# 类的工具?

    有什么工具可以从 NHibernate 映射文件生成 C 类 On the NHibernate 资源页面 http nhibernate info doc nh en index html toolsetguide s2在 有用的工具 下
  • axios POST 后在 Vue 组件中显示更新数据的问题

    我陷入了一个问题并希望JavaScript 绝地武士可以帮助我指明正确的方向 问题范围 我将 Laravel 集合传递给我的 Vue 组件 在组件内部 我迭代集合并通过 axios 提交表单 表单提交 数据库中数据更新 但是 我不清楚如何在
  • textFieldDidEndEditing 触发“太晚了”

    我有一个多视图流程 用户正在输入数据 并且我将其保存到模型类属性中的每一步 I use textFieldDidEndEditing检查输入是否有效 如果有效 则保存输入的数据 在视图上 我有一个 continueButtonClicked
  • java 中的不可变性

    In 有效的Java http java sun com docs books effective Bloch 建议在使对象不可变时将所有字段设为 Final 有必要这样做吗 仅仅不提供访问器方法不会使其变得不可变 例如 class A p
  • Knockoutjs 清除组合框中选定的值

    我有这个简单的 knockout js 应用程序 View
  • 当 ADO.NET 查询无法检索请求的数据时应抛出什么异常?

    为了向我们的应用程序添加一些参数验证和正确的使用语义 我们尝试向 NET 应用程序添加正确的异常处理 我的问题是 当在 ADO NET 中抛出异常时 如果特定查询没有返回数据或找不到数据 我应该使用什么类型的异常 伪代码 阅读 不要仔细检查
  • 如何在 JSDOC 中记录对象数组

    我有一个以对象数组作为参数的函数 并且想使用 JSDOC 描述参数 包括数组中对象的属性 如下例所示 param Array filter array of filter objects param function doSomething