vscode注释模板

vscode注释模板，用户代码片段功能（snippets）

最近想要像keil一样使用vscode的模板功能，参考网上查到的结果新建几个c文件模板，备份一下

 

 

1、具体操作

  选中首选项，选择用户片段，选择新建snippet或者编辑已经有的。

  我目前新建的片段方便平时使用，c_header,c_source,function_comment

  

2、文件内容

c_header

{
    "Print to console": {
        "prefix": "ch",
        "body": [
            "/*********************************************************************************",
            "  *Copyright(C),1996-2021, Company",
            "  *FileName:  ${TM_FILENAME_BASE}.h", // 文件名
            "  *Author:  wyp", //作者
            "  *Version:  V1.0", //版本
            "  *Date:", //完成日期
            "  *Description:", //用于主要说明此程序文件完成的主要功能
            "", //与其他模块或函数的接口、输出值、取值范围、
            "", //含义及参数间的控制、顺序、独立及依赖关系
            "  *History:", //修改历史记录列表，每条修改记录应包含修改日期、修改者及修改内容简介
            "     1.Date:",
            "       Author:",
            "       Modification:",
            "     2.",
            "**********************************************************************************/",
            "",
            "#ifndef  __${TM_FILENAME_BASE}_H__",
            "#define  __${TM_FILENAME_BASE}_H__",
            "",
            "/***************************************Includes***********************************/",
            "#include\"xxx.h\"",
            "",
            "",
            "/***************************************Macros***********************************/",
            "#define",
            "",
            "",
            "/***************************************Variables***********************************/",
            "",
            "",
            "",
            "/***************************************Functions***********************************/",
            "",
            "",
            "#endif",
            "/* [] END OF FILE */",
        ],
        "description": "A c_head file template."
    }
}

c_source

{
    "Print to console": {
        "prefix": "cs", //c_source
        "body": [
            "/*********************************************************************************",
            "  *Copyright(C),1996-2021, Company",
            "  *FileName:  ${TM_FILENAME_BASE}.c", // 文件名
            "  *Author:  wyp", //作者
            "  *Version:  V1.0", //版本
            "  *Date:", //完成日期
            "  *Description:", //用于主要说明此程序文件完成的主要功能
            "", //与其他模块或函数的接口、输出值、取值范围、
            "", //含义及参数间的控制、顺序、独立及依赖关系
            "  *History:", //修改历史记录列表，每条修改记录应包含修改日期、修改者及修改内容简介
            "     1.Date:",
            "       Author:",
            "       Modification:",
            "     2.",
            "**********************************************************************************/",
            "",
            "",
            "/***************************************Includes***********************************/",
            "#include\"xxx.h\"",
            "#include\"xxx.h\"",
            "",
            "",
            "/***************************************Macros***********************************/",
            "#define",
            "",
            "",
            "/***************************************Variables***********************************/",
            "",
            ""
            "",
            "/***************************************Functions***********************************/",
            "",
            "",
            "/* [] END OF FILE */",
        ],
        "description": "A c_source file template."
    }
}

function_comment

{
    "Print to console": {
        "prefix": "fc", //function_comment
        "body": [
            "/*************************************************",
            "Function:", // 函数名称
            "Description:", // 函数功能、性能等的描述
            "Calls:", // 被本函数调用的函数清单
            "Called By:", // 调用本函数的函数清单
            "Table Accessed:", // 被访问的表（此项仅对于牵扯到数据库操作的程序）
            "Table Updated:", // 被修改的表（此项仅对于牵扯到数据库操作的程序）
            "Input:", // 输入参数说明，包括每个参数的作// 用、取值说明及参数间关系。
            "Output:", // 对输出参数的说明。
            "Return:", // 函数返回值的说明
            "Others:", // 其它说明
            "*************************************************/",
        ],
        "description": "A function_comment file template."
    }
}

 

3、修改规则

  prefix：就是在使用的时候需要匹配的关键词，比如我在c_source中配置的关键词为cs，那么在写程序的时候，直接敲cs匹配到的第一个就是用户片段，敲下table键即可

  body：就是你需要添加的注释片段

  description：说明，会在 IntelliSense 候选栏中出现

需要注意的是文件中//是注释的意思，若要在引用中显示出来则需要用双引号括起来，并在行位加上逗号，否则提示有问题并且显示波浪线影响编辑。另外需要注意的是如果需要输出反斜杠或者双引号则需要转义字符。

具体修改规则可以参考博文  Visual Studio Code 自定义Snippet配置

4、剩余欢迎补充更新。。。

  2021.4.1 补充  使用如下变量可以替代添加的文本信息为当前文件名称  官网说明参考vscode snippets介绍

${TM_FILENAME_BASE}