Visual Studio 代码中是否有像 DocBlockr 这样的代码注释功能?
Are there code commenting features like DocBlockr in Visual Studio Code?
我使用 Sublime Text 3,Atom.io,和 Bracket.io 作为以前的编辑器。
我也非常喜欢 Mac 的新 Visual Studio 代码编辑器。
有没有类似DocBlockr for Sublime的代码注释功能?
这对我来说非常重要,因为我要评论大量代码。
如果你输入 /**
然后回车,你会在 visual studio 代码中得到 js 文档格式
如果您键入 /**[enter]
,它会完成该块,然后块中的任何键入都会被格式化(例如,在以 * 开头的行上按回车键,然后在下面插入一个带 * 的行)。
但 DocBlockr 的一个非常好的功能是它扫描下面的代码并在块中添加 @param 语句。 VS Code 似乎没有执行此操作。
Visual Studio 代码市场现在有一个用于 JavaScript 的文档块扩展,很快就会添加其他扩展。 https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments
以前,它对此有部分支持。正如其他人所提到的,您可以通过输入 /**
然后输入 ENTER 来获取它,但前提是您在 JavaScript 文件中。我不相信它适用于任何其他语言。
已请求一些类似的功能:
截至今天,发布 v1.1 时还没有,但这是一个获得高度评价的功能。如果你觉得它有用,我会投票支持这个功能,@mattferderer 已经发布了你应该添加投票的功能链接。在那之前,有 2 个插件可以很好地一起使用:
Document This(ext install docthis
)会为很多JsDoc风格的注解生成JsDoc风格的注释。在要生成文档的位置或内部使用命令 Ctrl + Alt + D
。
这适用于插件 "Complete JsDoc Tags"
Complete JsDoc Tags (ext install JSDocTagComplete
) 使用Ctrl + space
.
为大多数JsDoc样式注释提供代码补全
一起使用这两个插件非常有效。 DocThis 使用 Ctrl + Alt + D
给出初始生成的注释,然后可以使用 ctrl + space
添加特定的 JsDoc 注释 DocThis 没有 see/generate.
我没有找到 @mattferderer 提到的插件“Add JsDoc Comments”非常有用。它只为您提供 @param
和 @return
标签,除此之外什么都没有...
如果您想要函数或 voids 的参数注释,只需键入 ///
作为奖励,它们也会出现在鼠标悬停亮点中
有https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker.
它不如 PHPStorm 强大。但是它可以检测函数参数并为其添加模板行。
我使用 Sublime Text 3,Atom.io,和 Bracket.io 作为以前的编辑器。
我也非常喜欢 Mac 的新 Visual Studio 代码编辑器。
有没有类似DocBlockr for Sublime的代码注释功能? 这对我来说非常重要,因为我要评论大量代码。
如果你输入 /**
然后回车,你会在 visual studio 代码中得到 js 文档格式
如果您键入 /**[enter]
,它会完成该块,然后块中的任何键入都会被格式化(例如,在以 * 开头的行上按回车键,然后在下面插入一个带 * 的行)。
但 DocBlockr 的一个非常好的功能是它扫描下面的代码并在块中添加 @param 语句。 VS Code 似乎没有执行此操作。
Visual Studio 代码市场现在有一个用于 JavaScript 的文档块扩展,很快就会添加其他扩展。 https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments
以前,它对此有部分支持。正如其他人所提到的,您可以通过输入 /**
然后输入 ENTER 来获取它,但前提是您在 JavaScript 文件中。我不相信它适用于任何其他语言。
已请求一些类似的功能:
截至今天,发布 v1.1 时还没有,但这是一个获得高度评价的功能。如果你觉得它有用,我会投票支持这个功能,@mattferderer 已经发布了你应该添加投票的功能链接。在那之前,有 2 个插件可以很好地一起使用:
Document This(ext install docthis
)会为很多JsDoc风格的注解生成JsDoc风格的注释。在要生成文档的位置或内部使用命令 Ctrl + Alt + D
。
这适用于插件 "Complete JsDoc Tags"
Complete JsDoc Tags (ext install JSDocTagComplete
) 使用Ctrl + space
.
一起使用这两个插件非常有效。 DocThis 使用 Ctrl + Alt + D
给出初始生成的注释,然后可以使用 ctrl + space
添加特定的 JsDoc 注释 DocThis 没有 see/generate.
我没有找到 @mattferderer 提到的插件“Add JsDoc Comments”非常有用。它只为您提供 @param
和 @return
标签,除此之外什么都没有...
如果您想要函数或 voids 的参数注释,只需键入 /// 作为奖励,它们也会出现在鼠标悬停亮点中
有https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker.
它不如 PHPStorm 强大。但是它可以检测函数参数并为其添加模板行。