我使用Sublime Text 3,Atom.io和Bracket.io作为以前的编辑器 .
我也非常喜欢Mac的新Visual Studio代码编辑器 .
是否有任何代码注释功能类似于Subbime的DocBlockr?这对我来说非常重要,因为我评论了很多代码 .
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-j
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
As of today, and release v1.1 there are not ,但这是一个高度投票的功能 . 如果您觉得有用,我会投票支持此功能,@ mattferderer已发布您应该添加投票的功能链接 . 在那之前,有两个插件可以很好地一起使用:
Document This ( ext install docthis )将为许多JsDoc样式注释生成JsDoc样式注释 . 在要生成文档的位置或内部使用命令 Ctrl + Alt + D .
ext install docthis
Ctrl + Alt + D
这适用于插件“完整的JsDoc标签”
Complete JsDoc Tags ( ext install JSDocTagComplete )使用 Ctrl + space 为大多数JsDoc样式注释提供代码完成 .
ext install JSDocTagComplete
Ctrl + space
将这两个插件一起使用非常有效 . DocThis使用 Ctrl + Alt + D 给出了初始生成的注释,然后可以使用 ctrl + space 添加DocThis看不到/生成的特定JsDoc注释 .
ctrl + space
我没有找到插件“ Add JsDoc Comments ”@mattferderer提到非常有用 . 它只为您提供 @param 和 @return 标签,没有别的......
@param
@return
如果您键入 /**[enter] ,则完成该块,然后格式化该块中的任何键入(例如,在以开头的行中输入,而在下面插入以及*) .
/**[enter]
但DocBlockr的一个非常好的功能是它扫描下面的代码并在块中添加@param语句 . VS Code似乎没有这样做 .
如果您输入 /** 然后输入并在visual studio代码中获得js doc格式
如果你想要函数或空洞的参数注释,只需输入///作为奖励,它们也会在鼠标悬停突出显示
有https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker .
它没有PHPStorm那么强大 . 但它可以检测功能参数并为其添加模板行 .
6 回答
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-j
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
As of today, and release v1.1 there are not ,但这是一个高度投票的功能 . 如果您觉得有用,我会投票支持此功能,@ mattferderer已发布您应该添加投票的功能链接 . 在那之前,有两个插件可以很好地一起使用:
Document This (
ext install docthis
)将为许多JsDoc样式注释生成JsDoc样式注释 . 在要生成文档的位置或内部使用命令Ctrl + Alt + D
.这适用于插件“完整的JsDoc标签”
Complete JsDoc Tags (
ext install JSDocTagComplete
)使用Ctrl + space
为大多数JsDoc样式注释提供代码完成 .将这两个插件一起使用非常有效 . DocThis使用
Ctrl + Alt + D
给出了初始生成的注释,然后可以使用ctrl + space
添加DocThis看不到/生成的特定JsDoc注释 .我没有找到插件“ Add JsDoc Comments ”@mattferderer提到非常有用 . 它只为您提供
@param
和@return
标签,没有别的......如果您键入
/**[enter]
,则完成该块,然后格式化该块中的任何键入(例如,在以开头的行中输入,而在下面插入以及*) .但DocBlockr的一个非常好的功能是它扫描下面的代码并在块中添加@param语句 . VS Code似乎没有这样做 .
如果您输入
/**
然后输入并在visual studio代码中获得js doc格式如果你想要函数或空洞的参数注释,只需输入///作为奖励,它们也会在鼠标悬停突出显示
有https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker .
它没有PHPStorm那么强大 . 但它可以检测功能参数并为其添加模板行 .