vscode 这样的注释怎么生成？

Question

如下图中的 @param 这样的注释怎么用快捷键生成？

Answer 1

看起来是TypeScript， visual studio code里面安装一个 Document This插件， 重启Visual Studio Code之后，将光标放置于function上面，快捷键是 Ctrl+Alt+D 加 Ctrl+Alt+D。

Answer 2

先写函数方法，参数，然后在添加/**,回车，回车之后会自动提取部分内容，然后手动完善。

Answer 3

试试Document This这个插件

Answer 4

最近也在找这样的扩展，找到一个可以满足要求的扩展：koroFileHeader

使用很简单：

快捷键Ctrl+alt+i 在文件头部添加注释，

快捷键ctrl+alt+t 在光标处添加 JSDoc 注释。

Answer 5

@GreatKevin 还是会有这个提示

Answer 6

vscode-fileheader

快捷键Ctrl+Shift+i

Answer 7

建议使用使用GoComment，mac使用快捷键ctrl+cmd+/，windows使用ctrl+alt+/，一键生成满足golint的注释，参考 https://blog.csdn.net/DreamCL...

Answer 8

通过用户代码片段实现
【具体实现方法】

1. 设置>用户代码片段>搜索框输入javascript（若是其他语言则设置其他语言的代码模板）

2. 复制替换javascprit.json中的内容（第一段为文件开头注释说明，第二段为方法注释说明），其中prefix字段值可替换成自己易记的缩写。

   {
    "Print to zsfile": {
        "prefix": "zsfile", 
        "body": [
            "/*",
            "* @Description: $0",
            "* @Author: your name",
            "* @Date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
            "* @LastEditTime: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
            "* @LastEditors: Please set LastEditors",
            "*/"
        ],
        "description": "a zhushi mode"
    },
    "Print to zsfunc": {
        "prefix": "zsfunc",
        "body": [
                "/**",
                " * @func $1",
                " * @desc $2",
                " * @param {$3} $4 $5",
                " * @return {$6} $7",
                " */"
        ],
        "description": "a func mode"
   }
   
   }

   【解决参考】

   • VSCode如何快速生成注释说明