使用代码片段Snippet快速输入常用代码块及注释[vscode]

一．说明

代码片段是一种简化代码编写的方式，允许开发者使用简短的前缀来快速插入常用的代码块，通过该方法可以快速便捷的输入常用注释或代码块，避免重复繁琐的操作。本文所述方法适用于vscode开发工具。

二．配置方法

• 在vscode界面按下快捷键：Ctrl+Shift+P

• 输入Snip，选择配置代码片段

• 根据所用语言需要配置代码片段的语言，如C语言则选择C

选择C之后会生成一个c.json的文件，该文件内部附带了配置代码片段所需的参数说明：

大概的意思是：

// 在这里放置你的 C 语言代码片段。每个代码片段都在一个片段名称下定义，并具有前缀、主体和

// 描述。前缀是用于触发代码片段的字符串，主体将被扩展并插入。可能的变量包括：

// $1、$2 用于制表符位置，$0 用于最终光标位置，以及 ${1:label}、${2:another} 用于占位符。

// 拥有相同 ID 的占位符是连接在一起的。

// 示例:

// "输出到控制台": {

// "prefix": "log",

// "body": [

// "console.log('$1');",

// "$2"

// ],

// "description": "输出到控制台"

// }

三．配置代码片段

例如，我现在要配制一个代码片段，当我需要在vscode编辑器中输入”.end”的时候，编辑器自动为我键入代码结束分割线：

"/*************************end of file**************************/"

则使用下叙代码：

        "Insert end line": {
            "prefix": ".end",
            "body": ["/*************************end of file**************************/",
                    ""],
            "description": "Insert a line of end"
        }

其中，各部分关键词的作用如下：

保存该.json文件后，在代码编辑页面输入.end并按下TAB键，则编辑器会自动将.end转化为我们需要配置的代码片段

“/*************************end of file**************************/”

同样的，按照上述说明，我们现在使用的再复杂一点，假设我们需要插入一段Doxygen注释，用于说明某段所编写的函数的作用：

        "Insert Doxygen information": {

            "prefix": ".dox",

            "body": [

        "",

        "/*",

        "**********************************************************************************************",

        "*  @time ${1:修改日期} ",

        "*  @brief ${2:函数概要说明}",

        "*  @param ${3:参数}",

        "*  @return ${4:返回值}",

        "*  @attention ${5:注意项}",

        "**********************************************************************************************",

        "*/",

        ""

              ],

            "description": "Insert Doxygen information"

        }

则输入.dox后编辑器自动替换为我们编辑的格式，此时可以键入TAB在“修改日期”“函数概要说明”“参数”“返回值”“注意事项”等初始文本变量之间快速切换。

四．总结

Snippet功能强大，除可以配置快捷输入用来快速生成注释模板外，还可以通过类似的配置，快速设置常用代码语法格式，如for循环，while循环，switch case等语法结构，缩短开发过程中的繁琐操作和流程。