如何使用 JSDoc 记录元组?

2023-12-20

是否有某种使用 JSDoc 记录元组的标准?

给出以下代码,这是记录数组中特定索引位置处的值的正确方法吗?

/**
 * @param {Array.<number,number>} tuple_variable description
 * @param {number} tuple_variable[0] description
 * @param {number} tuple_variable[1] description
 */
function document_tuple( tuple_variable: [number,number] ) {
   // omitted
}

如果您想要一个包含每个数组元素的描述的完全扩展版本,则可以使用以下内容:

/**
 * @typedef {number} MyTupleIndex0 - Description of index 0...
 * @typedef {number} MyTupleIndex1 - Description of index 1...
 * @typedef {[MyTupleIndex0, MyTupleIndex1]} MyTuple
 * @param {MyTuple} tuple_variable
 */
function document_tuple(tuple_variable) {
  // ommited
}

或者,更简洁,但没有描述:

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

如何使用 JSDoc 记录元组? 的相关文章

  • React 16.7 - React.SFC 现已弃用

    我用来声明无状态组件 如下所示 const example React SFC
  • 在 Angular 2+ 中进行 DOM 操作的正确方法

    我知道有一些类似的问题 但没有人回答我的问题 基本上 以角度方式操作 DOM 的正确方法是什么 比如说我有这个 html
  • TypeORM 插入带有外键的行

    我之间有 OneToMany 关系聊天室1 M gt 留言我遇到的问题是 每当我尝试插入一条消息 或大量消息 时 ChatRoom 的外键为空 此外 我正在上传我的设置 Entity messages export class Messag
  • `type Constructor = Function and {prototype: T }` 如何应用于 TypeScript 中的抽象构造函数类型?

    TypeScript 中有一个关于抽象构造函数类型的问答 这是我想知道答案的问题 TypeScript 中的抽象构造函数类型 https stackoverflow com questions 36886082 abstract const
  • TypeScript:将模块拆分为多个文件

    我想将同一模块中的类定义拆分为多个文件 所以我确实喜欢这个并且它有效 a ts module MyModule class ClassA b ts module My Module class ClassB 然后我尝试在 ClassB 中使
  • Typescript 在 VS2012 中无法正确编译

    没有明确的原因 Typescript 突然停止可靠地编译成 JS 代码 使用 VS2012 Typescript for VS 版本 0 8 3 1 和 Web Essentials 版本 2 6 设置为 保存时编译 我可以创建一个新的 T
  • angular2存储许多字符串值

    我有一些必须在许多组件中使用的字符串常量值 我不想在各个组件中硬编码或将它们写为字符串 在 Angular2 应用程序中维护它们的最佳位置在哪里 解决方案之一是将字符串放置在共享服务中 将服务注入到需要该属性的每个组件中 如果您的字符串不是
  • 与 webpack 捆绑后,无法读取枚举的未定义属性

    我有一个 React 库 我想使用 Webpack 来构建它 该库是使用 Typescript 编写的 似乎一切正常 但由于某种原因枚举却不起作用 当我将库安装到我的 React 应用程序中时 我发现Cannot read properti
  • Observable:如果前面有map(),为什么不会导致subscribe()成功?

    我参考这个post https stackoverflow com questions 34671715 angular2 http get map subscribe and observable pattern basic unders
  • Angular 6 http.delete 请求不起作用

    我似乎无法让我的删除请求发挥作用 我已经完成了所有的获取请求 但现在我被困在删除上 似乎无法理解它 console log 的 URL 始终正确 并且删除请求通过 Postman 工作正常 有什么想法吗 HTML
  • 如何为 Angular 4、5 中的动态元素分配哈希 ID ref id

    如果我的问题很愚蠢 我很抱歉 我有 30 多个静态 ng container 和一些独特的静态 hashtagID 但我想在 ngFor 的帮助下动态创建它们 public lists food book cook 期望输出
  • “未知”与“任何”

    TypeScript 3 0 引入unknown根据他们的 wiki 输入 未知现在是保留类型名称 因为它现在是内置类型 根据您对未知的预期用途 您可能需要删除 完全声明 有利于新引入的未知类型 或者 将其重命名为其他名称 有什么区别unk
  • 如何使 Angular Reactive Formarray 中的级联下拉菜单工作而不弄乱下拉值

    我有一个角度 4 的表单 其中包含名字 姓氏和一个包含 2 个下拉菜单 选择 的表单数组 用作级联下拉菜单和一个删除按钮 表单的其余部分还包含一个发送按钮和一个添加选项按钮 我在此处添加了屏幕截图 以便您更好地理解 表单添加 删除按钮和发送
  • Svelte:无法识别导入的 TypeScript 文件

    我正在尝试使用 Rollup 使用 Svelte 和 TypeScript 构建一个应用程序 当我尝试构建我的 Svelte 组件时 我似乎无法让它编译我的 ts包含的文件 svelte成分 我不断收到此错误 Error Unexpecte
  • 在 Angular 6 服务中获取当前路由参数的最佳方法是什么?

    我试图找出在 Angular 6 中获取当前路由参数的最佳方法是什么 目前我必须通过ActivatedRoute到服务的方法作为参数 然后在服务中使用它 export class MainComponent constructor priv
  • 渲染作为 Prop 传入的 Component

    我怎样才能渲染一个StyledComponent它是作为道具传入的吗 我正在传递一个Spinner组件到我的BarComponent作为渲染的道具 我尝试使用 this props icon in my BarComponent在下面的示例
  • D3、TS 和 Angular 2

    我正在尝试将 D3 v4 与 Angular 2 Typescript 一起使用 我目前正在研究 D3 v4 我能够遵循 stackoverflow 中类似问题的一些答案 但没有成功 我已经导入了大部分 D3 库及其类型 我使用的是 TS
  • 将 Backbone 结构转换为 TypeScript

    看看 Backbonejs 的实现扩展功能 http backbonejs org docs backbone html section 186 它表明它不是一个基本的原型扩展 当主干扩展直接转换为 TypeScript 类时 有些东西会停
  • 使用属性和泛型类型获取“keyof”中项目的类型

    我想定义一个具有泛型类型的接口 该接口必须接受一个对象 其键作为 根字段名称 值作为对象数组 该数组定义一些子字段 其键作为子字段的名称 type 作为字段值的类型 像这样的东西 interface Inputs emails email
  • 使用打字稿的 Angular 6 的黄金布局?

    我在用黄金布局 https golden layout com 与 Angular 6 一起 如下本教程 https npm taobao org package embedded enterprises ng6 golden layout

随机推荐

  • Leaflet Control Search:打开弹出窗口搜索结果

    我正在使用很棒的插件传单 控制 搜索 http labs easyblog it maps leaflet search 为了在我的地图上搜索标记 来自 geoJson 标记组 效果很好 我现在只有一个简单的问题 如何打开搜索结果标记的弹出
  • Google 在 SingleChildScrollView 中的表单内绘制地图

    我有一个google map inside column inside SingleChildScrollView 我可以水平平移地图 但是垂直平移时SingleChildScrollView捕获事件并自行滚动 我如何在收到任何事件时平移地
  • QGraphicsView fitInView 边距

    为什么这个 graphics view gt fitInView scene gt sceneRect Qt KeepAspectRatio 没有按预期工作 它没有正确适合场景矩形 显示其周围的边距 原因是这样的 https bugrepo
  • for 循环中的分号单个表达式

    为什么最后有一个分号Proc num stack slots i lt 0在下面的代码中 我认为分号是 OCaml 中的分隔符 我们是否可以始终为块的最后一个表达式添加一个可选的分号 for i 0 to Proc num register
  • 使用 azure b2c 进行 SSO 时,为什么 api 连接器未返回电子邮件?

    我有一个带有 API 连接器的用户流 我正在使用 发送令牌之前 https learn microsoft com en us azure active directory b2c api connectors overview pivot
  • ASPNET MVC 4 应用程序中的 Jquery 脚本顺序

    我正在使用 jqgrid 开发 ASPNET MVC 4 项目 那里 ASPNET MVC 4 默认放置 Scripts Render bundles jquery 在 Layout cshtml 文件末尾 现在 我有一个 Index cs
  • 行高不均匀。文本上方的空间比下方更大

    我遇到了一些字体问题 例如 Josefin Sans 文本上方和下方的空间不均匀 这使得无法垂直对齐文本 看这个http jsfiddle net G5aVK http jsfiddle net G5aVK HTML div class t
  • Rails 和 Postgres:迁移到change_colomn 会出现错误“无法转换为没有时区的时间戳类型”

    将 deleted at 时间列转换为日期时间列的 Rails 迁移失败 关于如何解决这个问题有什么想法吗 如果相关的话 这是 Postgres 的全新安装 change column products deleted at datetim
  • 有没有办法在 Python 中传递块参数而不先将其定义为函数?

    在 Ruby 中 块参数的工作方式如下 def foo bar block block 4 end foo bar do x puts x puts x 2 end begin 4 8 end 我在 Python 中看到了以下等效项 但我发
  • 使用 UI 测试测试操作扩展

    是否可以对 Action Extension 目标执行 UI 测试 我无法使用操作扩展作为 要测试的目标 来创建 UI 测试目标 我正在尝试从 Safari 中加载操作扩展 或照片 尽管 Safari 两者都是首选 如果我记录我的互动 我可
  • Android 片段混乱

    我对 Android 中片段的正确逻辑使用有疑问 我知道它的设计目的是为了改善平板电脑体验 但这是否意味着片段通常只能用于此目的 或者使用片段作为自定义复合视图的替代品会是糟糕的开发实践吗 例如 我正在编写一个应用程序来记录 当生成得分表时
  • 如何在鼠标悬停时获取直方图中数据元素的索引?

    我有一个d3 v3 min js http d3js org d3 v3 min js以此为参考创建直方图使用 d3 的直方图 http bl ocks org nnattawat 8916402我想在一个单独的图 散点图 中突出显示落在该
  • ImageView:如果 ImageView 不可见(在 ScrollView 内),则自动回收位图

    所以 我已经研究 ImageView 源代码有一段时间了 但我还没有找到一个钩子来做到这一点 问题 假设 ScrollView 中有 30 个 400x800 图像 图像数量是可变的 由于它们正好适合屏幕 因此每个它们需要 1 3 MB 的
  • Python 网络浏览器问题

    我正在使用 python webbrowser 模块在系统上的默认 Web 浏览器中打开网页 我想检查该网站是否已在浏览器中打开 如果没有打开 则仅打开一个新选项卡 窗口 否则重新加载已经打开的页面 有没有办法用网络浏览器模块来做到这一点
  • 如何在view.bounds上添加CAGradientLayer等子图层? [复制]

    这个问题在这里已经有答案了 如何将我的渐变图层作为子图层添加到具有相同大小的视图中 我想在其他类中使用它 我尝试用 self bounds 来做到这一点 但没有成功 如果我给它严格的尺寸 例如 gradientLayer frame CGR
  • 获取viewpager中当前的Fragment实例

    下面是我的代码3 Fragment classes每个都嵌入了 3 个选项卡ViewPager 我有一个菜单选项 如图所示onOptionsItemSelected 通过选择一个选项 我需要更新当前可见的片段 要更新 我必须调用片段类中的一
  • 批量更改计算机分辨率的命令

    我想在批处理文件中编写一个命令来更改计算机的分辨率 我使用的是Windows XP 我需要将分辨率设置为1024 768 我需要更多选择 所以我开发了更改屏幕分辨率 exe http tools taubenkorb at change s
  • 使用 PhoneGap 将照片从 iPhone 上传到 PHP

    我有一个在 PHP 中工作的简单上传表单 在 Web 中工作 并且还能够使用 PhoneGap base64 从 iPhone 捕获照片并将其显示在设备上 但我不知道如何使用 PHP 将其上传到我的服务器 这是在 PHP 中运行的代码 索引
  • 使用 Spring OAuth 将来自 OAuth2 服务器的令牌存储在 cookie 中

    Spring OAuth2 是否提供任何配置来使用不透明或 JWT 令牌创建 cookie 到目前为止 我在互联网上找到的配置描述了授权服务器及其客户端的创建 在我的例子中 客户端是一个网关 其上有一个 Angular 4 应用程序 位于同
  • 如何使用 JSDoc 记录元组?

    是否有某种使用 JSDoc 记录元组的标准 给出以下代码 这是记录数组中特定索引位置处的值的正确方法吗 param Array