JSDOC:如何记录函数的内部变量

2024-04-12

有没有办法让 JSDOC 显示函数内部的变量而不使用@命名空间函数前面的注释?

我做了一个小测试对象,但它只会显示内部变量k对于最后一个函数,它被声明为命名空间。我想使用@成员!注释和精确@name注释将在下面调用的第二个方法中显示内部变量diff。我正在使用选项在命令上运行 jsdoc3--访问“全部”--解释.

这是测试对象的代码:

(function(){
    "use strict";
    /**
     * @namespace
     * @type {{}}
     */
    window.myFunctions = {};
    /**
     * Return the sum
     * @param {number} i
     * @param {number} j
     * @return {number}
     */
    window.myFunctions.sum = function(i, j) {
      /**  @type {number} */
      var k = i + j;
      return k;
    };
    /**
     * Return the difference i - j
     * @param {number} i
     * @param {number} j
     * @return {number}
     */
    window.myFunctions.diff = function(i, j) {
      /**
       * @inner
       * @memberof! window.myFunctions.diff
       * @type {number}
       * @name window.myFunctions.diff~k
       */
      var k = i - j;
      return k;
    };
    /**
     * Return the product
     * @namespace
     * @param {number} i
     * @param {number} j
     * @return {number}
     */
    window.myFunctions.multiply = function(i, j) {
      /** @type {number} */
      var k = i * j;
      return k;
    }
});

我注意到你的代码在 IIFE 中,你应该阅读本期 https://github.com/jsdoc3/jsdoc/issues/456

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

JSDOC:如何记录函数的内部变量 的相关文章

随机推荐

  • 规范的 HTTP POST 代码?

    我见过很多发送 http post 的实现 并且不可否认 我并不完全理解底层细节以了解需要什么 在 C NET 3 5 中发送 HTTP POST 的简洁 正确 规范代码是什么 我想要一个通用方法 例如 public string Send
  • .net MAUI c# 后台任务ContinueWith和通知事件

    编辑 已解决 见下文 编辑 这是一个新手问题 我只是深入研究 C 和异步 为什么我想要 单击按钮 按顺序运行多个任务 但在后台线程中一个接一个地运行 如果可能的话 正在运行的任务应该通知它们的进度 现在我可以单击按钮并启动任务链 但在完成事
  • pandas 正则表达式从第一次出现的字符开始向前和向后查看

    我有像下面这样的Python字符串 1234 4534 41247612 2462184 2131 GHI xlsx 1234 4534 sfhaksj DHJKhd hJD 41247612 2462184 2131 PQRST GHI
  • Sharp JS 依赖性破坏了 Elastic Beanstalk 上的 Express Server

    我觉得这毫无用处 因为我的难题已在多个不同的线程中讨论过 但没有任何效果 我有一个 ExpressJS 节点服务器部署到 AWS Elastic Beanstalk 当我几周前第一次尝试部署时 我无法让它运行 直到我最终意识到我的许多依赖项
  • DEP0600:部署失败。 XmlException - '.'(十六进制值 0x00)是无效字符

    MS VS2017 微软 Visual Studio 2017 DEP0600 部署失败 XmlException 十六进制值 0x00 是无效字符 编辑开始 解决方案可能就在附近 请保留建议一天 在 回复下面的评论 我已将原来的VS201
  • Firebase 将匿名用户帐户转换为永久帐户错误

    使用 Firebase for web 我可以成功创建匿名用户 我还可以创建一个新的电子邮件 密码用户 但是当尝试将匿名用户转换为电子邮件 密码用户时 我收到错误 auth provider already linked User can
  • C#:设置任意维度数组中的所有值

    我正在寻找一种将多维数组中的每个值设置为单个值的方法 问题是维数在编译时是未知的 它可能是一维的 也可能是 4 维的 自从foreach不允许你设定价值观 我可以实现这一目标的一种方法是什么 非常感谢 虽然这个问题表面上看起来很简单 但实际
  • sqlite - 查找可以由一组成分制成的食谱

    现在我在ios应用程序中使用sqlite 我希望能够搜索可以从成分列表中制作的食谱 即作为所提供成分的子集的食谱 例如 Recipe 1 A B C Recipe 2 A B Recipe 3 C D Recipe 4 A Recipe 5
  • 恢复 Vim 备份

    Vim 的文件备份系统刚刚保存了我众所周知的 但我有一个问题 我有 vim 保存备份到 vim backups 为了恢复它们 我进入该目录并将所需的文件 按日期排序 复制回项目文件夹中的必要目录 很简单 只有 5 个文件 然而 令我惊讶的是
  • 在 iPhone 地图中显示当前位置的标题

    我是 iPhone 开发新手 我已经创建了地图应用程序 并显示了当前位置并将图钉放置到当前位置 现在我想在单击图钉时显示当前位置的标题和副标题 请帮帮我 Thanks 要显示标题和副标题 您添加到地图的注释对象必须响应 title and
  • Swing JButton Swing 的圆角没有实际 JButton 的功能 [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 1 https i stack imgur com rZJjV png 我已经浏览过代码Swing 外观的 Java 文档 http
  • CSS 中区分:通过 Tab 键获得焦点和:通过单击获得焦点

    虽然我很确定我的问题的答案是 做不到 但我想确定一下并在这里问你们 我有一个相当典型的场景 我想通过我的网站启用选项卡 即使用键盘上的选项卡键 用户刚刚点击的项目应该通过 CSS 进行视觉标记 到目前为止 一切都很好 显然 这需要焦点伪类
  • 如何区分未传递的参数和传递错误值的参数?

    我试图找出在 Perl 中区分未传递参数和参数已作为 0 传递的情况的最佳方法 因为它们对我来说意味着不同的事情 通常我喜欢这种歧义 但在本例中我生成 SQL 因此我想用 NULL 替换未定义的参数 但将 0 保留为 0 所以这就是歧义 s
  • 查询 Jenkins 中最后成功的版本号并进行更改

    例子 32 fail 31 stable no change triggered by parent 30 stable with changes 29 fail 我想要返回一个查询30 到目前为止我得到的是 要查询最后一个稳定版本号 ht
  • 通过将函数应用于数据框的每一行来创建具有命名值的列表

    我试图通过将函数应用于数据帧的每一行来获取每个元素都有名称的列表 但无法获得正确的输出 假设这是我想要应用于每一行的函数 format setup name lt function m v s a lt list a paste m mac
  • 如何使用 TensorFlow 加载稀疏数据?

    有一个关于加载稀疏数据的小片段 但我不知道如何使用它 SparseTensors 不能很好地处理队列 如果您使用 SparseTensors 则必须在批处理后使用 tf parse example 解码字符串记录 而不是在批处理之前使用 t
  • Ruby 中的每个自动计数器?

    我想使用 for each 和计数器 i 0 for blah in blahs puts i to s blah i 1 end 有更好的方法吗 Note 我不知道是否blahs是一个数组或一个散列 但必须这样做blahs i 不会让它变
  • 如何让eclipse记住ssh密钥密码?

    我将 Egit 与 Eclipse 结合使用来使用 git 并访问 github 一切工作正常 但我想省略一件事id rsa每次我将提交推送到 github 时都需要输入密钥密码 每次重新启动 Eclipse 并尝试推送时 都会要求我输入密
  • 对齐CSS中旋转的元素

    我尝试旋转页面上的 div 并将其靠在其父元素 在本例中为主体 的左侧 我了解变换原点 但无论我插入什么值 它都无法正确对齐 http jsfiddle net QpHCM http jsfiddle net QpHCM HTML div
  • JSDOC:如何记录函数的内部变量

    有没有办法让 JSDOC 显示函数内部的变量而不使用 命名空间函数前面的注释 我做了一个小测试对象 但它只会显示内部变量k对于最后一个函数 它被声明为命名空间 我想使用 成员 注释和精确 name注释将在下面调用的第二个方法中显示内部变量d