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

zer*_*fel 37 jsdoc visual-studio-code

我目前正在开发一个NodeJS项目,并发现没有内置的功能来为函数/方法创建JSDoc注释.

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

例如,WebStorm具有一些非常简洁的JSDoc功能.可以以某种方式实现类似的功能吗?

Dom*_*nic 57

Visual Studio 1.10现在能够生成JSDoc注释.

只需/**在功能上方输入.

请参阅https://code.visualstudio.com/updates/v1_10#_auto-jsdoc-comments

  • 有没有办法将其分配给键盘快捷键?我知道 `/**` 并没有那么长,但是如果能有这么多我现在发表的 JSDoc 评论就太好了。 (4认同)
  • 不错的功能!然而它似乎不适用于胖箭头功能,并且由于某些原因它不会添加@returns和{type} - 至少在我的设置上.只是人们可能会考虑使用三方插件:). (3认同)
  • 该功能实际上是通过输入“/** */”来触发的。如果您启用了自动关闭括号,则会自动发生这种情况。 (3认同)
  • @returns你可以留意这张票:https://github.com/Microsoft/TypeScript/issues/14248 (2认同)
  • 我的 Visual Studio 代码版本是 1.24.1 。仍然没有添加@returns。 (2认同)

Ben*_*ero 17

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

您可以在View> VS代码中安装扩展Command Palette

安装扩展程序


Jac*_*ack 17

我真的很喜欢"记录这个".

安装

启动VS Code Quick Open(⌘+ P),粘贴以下命令,然后按enter键.
ext install docthis

https://marketplace.visualstudio.com/items?itemName=joelday.docthis

它有一些很好的功能,如将文件块添加到整个文件.