有没有办法在 Visual Studio Code 中生成 JSDoc 注释答案

【问题标题】：Is there a way to generate JSDoc comments in Visual Studio Code有没有办法在 Visual Studio Code 中生成 JSDoc 注释
【发布时间】：2016-03-17 04:34:44
【问题描述】：

我目前正在开发一个 NodeJS 项目，发现没有内置功能可以为函数/方法创建 JSDoc cmets。

我知道存在的 TypeScript 定义，但我真的找不到任何符合我需要的东西。

例如，WebStorm 有一些非常简洁的 JSDoc 功能。有人能以某种方式实现类似的功能吗？

【问题讨论】：

标签： visual-studio-code jsdoc

【解决方案1】：

不妨试试这个 JSDoc 扩展：https://marketplace.visualstudio.com/items/stevencl.addDocComments

您可以从View > Command Palette 在 VS Code 中安装扩展

【讨论】：

【解决方案2】：

我真的很喜欢“记录这个”。

安装

启动 VS Code 快速打开 (⌘+P)，粘贴以下命令，然后回车。
ext install docthis

https://marketplace.visualstudio.com/items?itemName=oouo-diogo-perdigao.docthis

它有一些不错的功能，比如将文档块添加到整个文件中。

【讨论】：

链接已失效，现在使用this 来自GitHub的fork marketplace.visualstudio.com/…

【解决方案3】：

Visual Studio 1.10 现在可以生成 JSDoc cmets。

只需在函数上方输入/**

另见：

【讨论】：

不错的功能！然而，它似乎不适用于胖箭头函数，并且由于某种原因它没有添加 @returns 和 {type} —— 至少在我的设置中是这样。只是提醒人们可能会考虑使用 3 方插件 :)。
对于@returns，您可以关注这张票：github.com/Microsoft/TypeScript/issues/14248
我的 Visual Studio 代码版本是 1.24.1 。仍然没有添加@returns。
该功能实际上是通过输入/** */来触发的。如果您启用了自动关闭括号，这会自动发生。
有没有办法将它分配给键盘快捷键？我知道/** 没有那么长，但如果我现在制作了多少 JSDoc cmets，那就太好了。

【解决方案4】：

一个相关的。

我正在寻找 Visual Studio 2017 社区版，以下帮助：

https://marketplace.visualstudio.com/items?itemName=MichaelObermeyer.DocStubsJs2017

【讨论】：

【解决方案5】：

https://marketplace.visualstudio.com/items?itemName=kimlimjustin.jsdoc-generator

只需选择整个函数直到第一个块{ 并命令 vscode 生成 jsdoc。适用于箭头函数/打字稿。

【讨论】：

【解决方案6】：

对于像我一样，每次想要插入一些 JSDoc cmets 时都懒得输入 /** 的人，我发现以下解决方案非常有效。 请注意，这是使用 code-server 3.12.0 实现的

安装宏扩展https://github.com/geddski/macros
将以下块添加到您的settings.json

"macros": {
  "JSDoc": [
    {"command": "type", "args": {"text": "/**"}},
    "insertSnippet"
  ]
}

将以下内容添加到您的keybindings.json

{
  "key": "ctrl+shift+/",
  "command": "macros.JSDoc",
  "when": "editorFocus"
}

现在，只要您输入 ctrl+shift+/，智能感知自动完成功能就会弹出，点击回车即可享受。

【讨论】：