【问题标题】:Auto JSDoc generation in Visual Studio Code broken?Visual Studio Code 中的自动 JSDoc 生成损坏?
【发布时间】:2017-07-31 00:04:04
【问题描述】:

我正在做 TypeScript 开发,最近更新到 Visual Studio Code 版本 1.10.2。此版本中宣传的一件事是 auto generation of JSDoc comments,只需在 JavaScript 或 TypeScript 函数前键入 /** 和 RETURN,您将获得一个 JSDoc 注释块,其中包含用于函数参数的自定义占位符。非常酷,非常有用。

但是,这对我不起作用。输入/**,我得到了结束*/,但没有别的,即使在输入返回之后也是如此。更奇怪的是,我发誓这曾经为我工作。这可能是一个扩展,但我安装的唯一相关扩展是Document This,并且必须由热键触发。我尝试重新安装 Document This,但无济于事:我仍然没有得到那个可爱的自动生成。我也查看了设置,但没有找到任何相关的内容。我也在 OS X 10.10.5 和 Windows 10 下试过这个;同样的结果。

此功能对其他人有用吗?关于如何启用它或调试/修复问题的任何建议?

【问题讨论】:

  • 遇到与 1.13.1 相同的问题。在使用 VSC 的六个人中,我是办公室里唯一一个遇到这个问题的人。你有没有弄清楚它是什么?
  • 不,我丢球了。一个问题是我安装了“Document This”扩展,我不确定它或 VSC 是否在完成这项工作。无论如何,有时它对我有用,有时对我有用;我还没想出一个模式。
  • 我能说的最好的。 VSC 正在覆盖其他 JSDoc 插件的行为。禁用 jsDocCompletion.enabled 似乎对此没有影响。我注意到内置的 JSDoc 自动补全适用于function foo(bar),但不适用于this.foo=function(bar)。现在我只是手动输入我们的 JSDocs。呃。

标签: typescript visual-studio-code jsdoc


【解决方案1】:

我在 VSCode 中实现了自动 jsdoc 补全。

如果您发现此功能存在问题并且不是由扩展程序引起的,即它在禁用所有扩展的情况下进行回购——请打开一个新的 github 问题:https://github.com/Microsoft/vscode/issues/new 包括一些示例代码以及一组简短的回购步骤,以便有人可以调查可能出了什么问题。

谢谢

【讨论】:

  • 谢谢(现在这是服务),我会这样做的。但是,您对可能出现的问题有任何猜测吗?例如,这可能是由使用较旧 (2.0.10) 版本的 TypeScript 引起的吗?
  • 可能,但如果没有更多信息,我不能肯定地说。最新的 TS 版本有许多重要的错误修复。您可能遇到了 TS 2.2 已经解决的错误
猜你喜欢
  • 2020-12-28
  • 2018-09-16
  • 2016-03-17
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2022-01-26
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多