草庐IT

javascript - 如何在 Visual Studio Intellisense 中记录 JavaScript 配置对象

coder 2024-05-10 原文

我一直在使用 Visual Studio 的 JavaScript Intellisense functionality一段时间以来，我对它为标准 API 提供建议的效果非常满意，但我发现我无法让 Visual Studio 理解配置对象(即具有多个可选或必需属性的单个对象作为函数的参数).

official JSDoc syntax建议如果期望参数具有属性，则为每个参数创建一个单独的 @param 行并使用点表示法:

/**
 * @param {Object} config
 * @param {String} config.name
 * @param {Number} config.gold
 */
function do_it(config) { ... }

但是，Visual Studio 无法识别这一点 - 它将 config、config.name 和 config.gold 呈现为三个单独的顶部级参数。

更糟糕的是，方法主体中的自动完成功能也无法识别参数，更不用说它们的类型了:

唯一在 Visual Studio 中似乎更接近的解决方案是使用适当的文档(@constructor 和 @property 标记)编写从未调用的构造函数，这让我写了很多死代码，也违背了 JavaScript 的无类心态(这就是我首先使用配置对象的原因)。它甚至不让我写配置对象!

不仅如此，我还知道 Visual Studio 不需要它。例如，当我写出对 this library function 的调用时，它能够收集到参数对象需要名为 id、source 和 target 的属性，并在我创建对象时建议了这些名称函数参数的文字 - 并且没有一行文档。据推测，它来自于它们被使用的简单事实:

诚然，如果这些属性不在对象上且类型不正确，该方法确实会抛出异常，但仍然如此。 编辑:我最近能够使用对象文字参数在我自己的代码中复制这种效果 - 我用一个定义明确的对象调用了一个函数，当我调用该函数时它给了我 Intellisense 建议再次在我的代码的其他地方。但是我在函数体内仍然没有类型信息或语义访问。

Visual Studio 显然理解配置对象的概念，并且正在做一些逻辑来提供建议的属性。那个算法是什么？我如何在不破坏我的代码的情况下利用它？

最佳答案

您正在使用 correct JSDoc syntax ，但截至目前，Visual Studio 并未为具有命名属性的参数对象构建正确的 IntelliSense。除了您提到的方法之外，目前没有其他解决方法，但是您可以在适当的位置描述 config 对象并避免编写死代码，就像您提到的那样:

/**
 * @typedef  {object} TestConfig
 * @property {string} name
 * @property {number} gold
 *//**
 * @param    {TestConfig} config 
 */
function test(config) {

}

由于我们仅将此对象用于文档和自动完成目的，因此我们不需要实际对其进行编码。这并不比原始语法冗长多少，并且还具有记录配置对象的好处。

关于你的第二个问题，你可以看到 sigma.js 的 IntelliSense库是从解析函数代码本身的主体而不是 JSDoc 注释派生的。这就是为什么当您将缩小的“sigma.min.js”构建添加到您的项目时仍然可以使用它，其中的评论已被删除。

您可以测试此添加参数验证，类似于 library function 中的验证(尽管以任何其他方式访问 config.name 或 config.gold 也会产生相同的结果):

function do_it(config) {
    if (Object(config) !== config || arguments.length !== 1) throw 'do_it: wrong arguments.';
    if (typeof config.name !== 'string') throw 'config must have a name string field.';
    if (typeof config.gold !== 'number') throw 'config must have a gold number field.';
    ...
}

结果:

以类似的方式，一旦您提供了足够的信息，就会推断出正确的类型:

关于javascript - 如何在 Visual Studio Intellisense 中记录 JavaScript 配置对象，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/34276394/

何在Intellisensecodeconfignoreferrerjavascriptdocumentationvisual-studio-2015jsdocjavascript-intellisense

有关javascript - 如何在 Visual Studio Intellisense 中记录 JavaScript 配置对象的更多相关文章

  1. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  2. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣，我很好奇如何按顺序创建PI，而不是在过程结果之后生成数字，而是让数字在过程本身生成时显示。如果是这种情况，那么数字可以自行产生，我可以对以前看到的数字实现垃圾收集，从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法，类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

  3. ruby-on-rails - 按天对 Mongoid 对象进行分组 - 2

    在控制台中反复尝试之后，我想到了这种方法，可以按发生日期对类似activerecord的(Mongoid)对象进行分组。我不确定这是完成此任务的最佳方法，但它确实有效。有没有人有更好的建议，或者这是一个很好的方法？#eventsisanarrayofactiverecord-likeobjectsthatincludeatimeattributeevents.map{|event|#converteventsarrayintoanarrayofhasheswiththedayofthemonthandtheevent{:number=>event.time.day,:event=>ev

  4. ruby - 如何在 buildr 项目中使用 Ruby 代码？ - 2

    如何在buildr项目中使用Ruby？我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序，我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/)，但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻，因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  5. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们？ - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

  6. ruby-on-rails - 如何在 ruby​​ 中使用两个参数异步运行 exe？ - 2

    exe应该在我打开页面时运行。异步进程需要运行。有什么方法可以在ruby​​中使用两个参数异步运行exe吗？我已经尝试过ruby​​命令-system()、exec()但它正在等待过程完成。我需要用参数启动exe，无需等待进程完成是否有任何ruby​​gems会支持我的问题？ 最佳答案 您可以使用Process.spawn和Process.wait2:pid=Process.spawn'your.exe','--option'#Later...pid,status=Process.wait2pid您的程序将作为解释器的子进程执行。除

  7. ruby - 如何在续集中重新加载表模式？ - 2

    鉴于我有以下迁移:Sequel.migrationdoupdoalter_table:usersdoadd_column:is_admin,:default=>falseend#SequelrunsaDESCRIBEtablestatement,whenthemodelisloaded.#Atthispoint,itdoesnotknowthatusershaveais_adminflag.#Soitfails.@user=User.find(:email=>"admin@fancy-startup.example")@user.is_admin=true@user.save!ende

  8. ruby-on-rails - 如何验证非模型(甚至非对象)字段 - 2

    我有一个表单，其中有很多字段取自数组(而不是模型或对象)。我如何验证这些字段的存在？solve_problem_pathdo|f|%>... 最佳答案 创建一个简单的类来包装请求参数并使用ActiveModel::Validations。#definedsomewhere,atthesimplest:require'ostruct'classSolvetrue#youcouldevencheckthesolutionwithavalidatorvalidatedoerrors.add(:base,"WRONG!!!")unlesss

  9. Ruby 写入和读取对象到文件 - 2

    好的，所以我的目标是轻松地将一些数据保存到磁盘以备后用。您如何简单地写入然后读取一个对象？所以如果我有一个简单的类classCattr_accessor:a,:bdefinitialize(a,b)@a,@b=a,bendend所以如果我从中非常快地制作一个objobj=C.new("foo","bar")#justgaveitsomerandomvalues然后我可以把它变成一个kindaidstring=obj.to_s#whichreturns""我终于可以将此字符串打印到文件或其他内容中。我的问题是，我该如何再次将这个id变回一个对象？我知道我可以自己挑选信息并制作一个接受该信

  10. ruby - 如何在 Ruby 中拆分参数字符串 Bash 样式？ - 2

    我正在为一个项目制作一个简单的shell，我希望像在Bash中一样解析参数字符串。foobar"helloworld"fooz应该变成:["foo","bar","helloworld","fooz"]等等。到目前为止，我一直在使用CSV::parse_line，将列分隔符设置为""和.compact输出。问题是我现在必须选择是要支持单引号还是双引号。CSV不支持超过一个分隔符。Python有一个名为shlex的模块:>>>shlex.split("Test'helloworld'foo")['Test','helloworld','foo']>>>shlex.split('Test"

随机推荐