有没有办法在 Visual Studio 代码中生成 JSDoc 注释

Question

我目前正在开发一个 NodeJS 项目，发现没有为 functions/methods 创建 JSDoc 注释的内置功能。

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

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

Answer 1

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

您可以通过 View > Command Palette

在 VS Code 中安装扩展

Answer 2

我真的很喜欢“Document This”。

安装

启动 VS Code Quick Open (⌘+P)，粘贴以下命令，然后按回车键。
ext install docthis

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

它有一些不错的功能，例如向整个文件添加文档块。

Answer 3

Visual Studio 1.10 现在可以生成 JSDoc 注释。

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

另请参阅:

• VS Code Docs > Languages > Javascript > JSDoc Support
• VS Code February 2017 Release Notes > Auto JSDoc Comments

Answer 4

一个相关的。

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

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

Answer 5

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

只是 select 整个函数直到第一个块 { 和命令 vscode 生成 jsdoc。使用箭头 functions/typescript.

Answer 6

对于像我这样懒得在每次想插入一些 JSDoc 注释时键入 /** 的人，我发现以下解决方案非常有效。 请注意，这是使用代码服务器 3.12.0

实现的

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

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

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

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

---

现在，每当您键入 ctrl+shift+/ 时，智能感知自动完成功能就会弹出，按回车键即可享受。