美文网首页程序员
vscode中配置代码注释模板

vscode中配置代码注释模板

作者: 木巽 | 来源:发表于2022-05-27 16:38 被阅读0次

之前用Eclipse, IDEA开发java的时候,配置代码注释模板相信大家都用过,只要输入/**再回车,会把参数、作者、日期等信息生成在注释中,只要补上关键的文字内容就可以了。这样可以让代码更规范,也便于后期维护或生成文档。

Vue2在IDEA中也是可以开发的,公司新的项目用Vue3,IDEA中的前端插件比较少,像setup语法糖就不支持了。于是就改用vscode,所以就想在vscode中也配置注释模板,也算实现了:

按ctrl+shift+p快捷键,在新的输入框中输入snippets回车,点击“新建全局代码片段文件...” 随便输入一个文件名回车,文件内容如下:

{
    "Print to console": {
        "scope": "javascript,typescript,vue",
        "prefix": "elwin",
        "body": [
            "/**",
            " * @author Elwin ZHANG",
            " * @description: //TODO",
            " * @date $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE",
            " */",
        ],
        "description": "Elwin ZHANG's auto comments"
    }
}

保存后,在代码中输入elwin并回车,就会生成注释模板了。
scope中指在哪些文件类型中生效,prefix是指输入什么文本后触发,body中的内容是生成的内容。就这么简单实现了。

相关文章

网友评论

    本文标题:vscode中配置代码注释模板

    本文链接:https://www.haomeiwen.com/subject/vttvprtx.html