vscode添加自定义注释

简介: vscode添加自定义注释

第一步:

使用ctrl + shift + p 调出如下窗口,并且输入snippets
在这里插入图片描述

第二步:

进入 json文件编辑
这里以自定义 js注释为例:
【如果是 ts,则搜索 typescript.json

在这里插入图片描述

进入到 json 文件中后,添加如下代码,大家可以自定义设计,保存退出 我这里是一个类注释 一个方法注释
{
    // Place your snippets for javascript here. Each snippet is defined under a snippet name and has a prefix, body and 
    // description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
    // $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the 
    // same ids are connected.
    // Example:
    // "Print to console": {
    //     "prefix": "log",
    //     "body": [
    //         "console.log('$1');",
    //         "$2"
    //     ],
    //     "description": "Log output to console"
    // }
    "Print to js class": {
        "prefix": "*",
        "body": [
        "/**",
        " * @description : $0",
        " * @author : 'Hukang'",
        " * @param : '' ",
        " * @date : ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
        "*/"
        ],
    },
    "Print to js method": {
    "prefix": "*",
    "body": [
        "/**",
        " * @description : $0",
        " * @author : 'Hukang'",
        " * @param : '' ",
        " * @date : ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
        "*/"
        ],
    },
}

第三步:

保存退出后,我们可以在js文件中看到智能提示
点击之后会自动生成注释 ,同时date会自动生成

在这里插入图片描述

注意一下,这里html注释稍有不同
因为html注释格式为 < - - ! - - >
  "Print to html method": {
        "prefix": "zhushihtml",
        "body": [
            "<!-- ",
            "**@Description: $0",
            "-->"
        ],
    },

最后想分享一下红色警戒的源码 注释的格式 ,在红色警戒的源码公开之后,他的注释简直堪称经典
我整理了一下这段注释,致敬经典!

  "Print to js api": {
        "prefix": "nice",
        "body": [
            "/***************************************************************************************************",
            " * AircraftClass :: $0                                                                                *",
            " *                @Description: $0                                                                 *",
            " *                @Description: $0                                                                 *",
            " *                @Description: $0                                                                 *",
            " *                                                                                                 *",
            " * INPUT:$0                                                                                        *",
            " *                                                                                                 *",
            " * OUTPUT:$0                                                                                       *",
            " *                                                                                                 *",
            " * WARNINGS:$0                                                                                     *",
            " * HISTORY:                                                                                        *",
            " *         @MethodAuthor:  xxx                                                                 *",
            " *         @Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}                 *",
            "*==================================================================================================*/"
        ],
    },
相关文章
vscode ctrl+/ 注释快捷键失效
首次安装vscode 不知道为何会快捷键失效,首先想到的就是键位冲突! 于是解决了。
4798 0
vscode ctrl+/ 注释快捷键失效
|
4月前
|
Android开发
Vscode中注释变成繁体的解决方法
这篇文章提供了两种解决Vscode中注释变成繁体字的方法:第一种是通过设置语言模式来更改显示语言;第二种是更改文件的编码格式,如在UTF-8和GBK之间切换,以解决乱码问题。
Vscode中注释变成繁体的解决方法
|
6月前
|
JSON Ubuntu JavaScript
工具分享:VsCode注释神器,koro1FileHeader
工具分享:VsCode注释神器,koro1FileHeader
214 3
|
JavaScript 前端开发 Windows
VScode的注释和标题,标签,img的src属性(如何网页上插入图片)(Mac如何开启js控制台)(如何免费复制网页中的文字)
VScode的注释和标题,标签,img的src属性(如何网页上插入图片)(Mac如何开启js控制台)(如何免费复制网页中的文字)
|
小程序 PHP Perl
vscode设置php自定义注释格式
写代码一般的注释都是有格式的,方便自己和他人阅读代码,多人开发的时候,也能更快的找到这部分代码是由谁来编写的。 好的代码注释确实是一个好习惯,但是,有的时候就是这玩意有敲起来有点费劲~
237 0
|
JSON iOS开发 数据格式
在 VScode 中设置快捷键快速添加注释(文件头部、文件函数)
在编写代码的过程中,为了增加代码的可读性和维护性,我们通常会添加注释来解释代码的作用和功能。为了提高效率,我们可以在 VScode 中设置快捷键,以便快速添加注释,包括文件头部和函数注释。下面是详细的设置步骤:
4291 1
在 VScode 中设置快捷键快速添加注释(文件头部、文件函数)
|
PHP
vscode添加PHP代码注释的插件及设置教程
在vscode中点击扩展-->安装插件koroFileHeader
558 0
VSCode KoroFileHeader 注释插件(支持多种语言,可自定义)
VSCode KoroFileHeader 注释插件(支持多种语言,可自定义)
426 0
|
前端开发
前端知识学习案例13vs code-添加注释
前端知识学习案例13vs code-添加注释
49 0
前端知识学习案例13vs code-添加注释
|
自然语言处理 算法
vscode插件利器:自动生成代码注释、文档、算法复杂度
vscode插件利器:自动生成代码注释、文档、算法复杂度
1326 0
vscode插件利器:自动生成代码注释、文档、算法复杂度