我使用 Sublime Text 3、Atom.io 和 Bracket.io 作为以前的编辑器。
我也非常喜欢新的 Visual Studio Code Editor for Mac。
有没有类似 DocBlockr for Sublime 的代码注释功能?这对我来说非常重要,因为我评论了大量的代码。
我使用 Sublime Text 3、Atom.io 和 Bracket.io 作为以前的编辑器。
我也非常喜欢新的 Visual Studio Code Editor for Mac。
有没有类似 DocBlockr for Sublime 的代码注释功能?这对我来说非常重要,因为我评论了大量的代码。
Visual Studio Code Marketplace 现在有一个用于 JavaScript 的文档块扩展,其他可能很快就会添加。https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments
以前,它对此有部分支持。正如其他人所提到的,您可以通过键入/**
然后 ENTER 来获取它,但前提是您位于 JavaScript 文件中。我不相信它适用于任何其他语言。
已要求一些类似的功能:
如果您键入/**[enter]
,它将完成该块,然后对块内的任何键入进行格式化(例如,在以 * 开头的行上按 Enter 键,在下面插入另一个以 * 开头的行)。
但是 DocBlockr 的一个非常好的功能是它扫描下面的代码并在块中添加 @param 语句。VS Code 似乎没有这样做。
到今天为止,v1.1 版本还没有,但它是一个高度投票的功能。如果您觉得它有用,我会投票支持此功能,@mattferderer 已发布您应该添加投票的功能链接。在那之前,有 2 个插件可以很好地结合使用:
Document This (ext install docthis
) 将为许多 JsDoc 样式注释生成 JsDoc 样式注释。Ctrl + Alt + D
在要生成文档的地方或内部使用命令
这适用于插件“完整的 JsDoc 标签”
Complete JsDoc Tags (ext install JSDocTagComplete
) 为大多数使用Ctrl + space
.
将这两个插件一起使用非常有效。DocThis 给出初始生成的注释Ctrl + Alt + D
,然后可以使用ctrl + space
添加特定的 JsDoc 注释 DocThis 看不到/生成。
我没有发现 @mattferderer 提到的插件“添加 JsDoc 评论”非常有用。它只为您提供一个@param
和@return
标签,没有别的......
如果您键入/**
然后 ENTER 并在 Visual Studio 代码中获得 js doc 格式
如果您想要函数或空洞的参数注释,只需键入 /// 作为奖励,它们也会出现在鼠标悬停高亮中
有https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker。
它不如 PHPStorm 强大。但它可以检测函数参数并为其添加模板行。