在Visual Studio Code中是否有像DocBlockr这样的代码注释功能？

Question

我使用Sublime Text 3,Atom.io和Bracket.io作为以前的编辑器.

我也非常喜欢Mac的新Visual Studio代码编辑器.

是否有任何代码注释功能类似于Subbime的DocBlockr？这对我来说非常重要,因为我评论了很多代码.

Answer 1

Visual Studio Code Marketplace现在具有JavaScript的文档块扩展,其他可能很快就会添加.https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments

以前,它对此有部分支持.正如其他人所提到的,你可以通过键入/**然后输入来获得它,但前提是你在JavaScript文件中.我不认为它适用于任何其他语言.

已经要求提供一些类似的功能:

https://web.archive.org/web/20170910095011/https://visualstudio.uservoice.com/forums/293070-visual-studio-code/suggestions/9417975-intellisense-comments-need-improved-typedoc-and- Ĵ

https://web.archive.org/web/20170910095011/https://visualstudio.uservoice.com/forums/293070-visual-studio-code/suggestions/7899765-automatic-formatting-of-and-documentation

https://web.archive.org/web/20170910095011/https://visualstudio.uservoice.com/forums/293070-visual-studio-code/suggestions/8248872-true-jsdoc-support-for-ts-and- JS

Answer 2

如果您键入/**[enter]，然后块内的任何键入都被格式化（例如，在以 * 开头的行上按 Enter 并在下面插入另一个带有 * 的行），它将完成块。

但是 DocBlockr 的一个非常好的功能是它扫描下面的代码并在块中添加 @param 语句。VS Code 似乎没有这样做。

Answer 3

截至今天,并发布v1.1没有,但它是一个高度投票的功能.如果您觉得有用,我会投票支持此功能,@ mattferderer已发布您应该添加投票的功能链接.在那之前,有两个插件可以很好地一起使用:

Document This(ext install docthis)将为许多JsDoc样式注释生成JsDoc样式注释.Ctrl + Alt + D在要生成文档的位置或内部使用命令.

这适用于插件"完整的JsDoc标签"

完整的JsDoc标签(ext install JSDocTagComplete)使用提供大多数JsDoc样式注释的代码完成Ctrl + space.

将这两个插件一起使用非常有效.DocThis给出了初始生成的注释Ctrl + Alt + D,然后可以ctrl + space用来添加DocThis看不到/生成的特定JsDoc注释.

我没有找到插件" 添加JsDoc评论 "@mattferderer提到非常有用.它只是提供了一个@param和@return标签,并没有别的...

Answer 4

如果您输入/**然后输入，您将在 Visual Studio Code 中获得 js 文档格式