VSCode配置快速生成注释功能

---

前言

在计算机语言中，注释是计算机语言的一个重要组成部分，用于在源代码中解释代码的功用，可以增强程序的可读性，可维护性，或者用于在源代码中处理不需运行的代码段，来调试程序的功能执行。

---

一、VSCode

VSCode (Visual Studio Code)是Microsoft开发的免费开源代码编辑器。它适用于Windows、macOS和Linux操作系统。VSCode支持广泛的编程语言，并提供语法突出显示、代码完成、调试和Git集成等功能。它还有大量的扩展集合，可以安装以增强其功能。VSCode被开发人员广泛使用，被认为是当今最流行的代码编辑器之一。下文介绍使用VSCode时，怎样配置注释模板，以便于在开发中简化注释编写时间，统一注释格式。

二、步骤

1. 打开命令窗口（快捷键Ctrl+Shift+P，或者在菜单栏中选择查看->命令面板）
   

2. 输入snippet，并选择Configure User Snippets
   

3. 选择语言，创建对应json文件，这里以C语言为例，会创建出来新文件c.json
   
   

4. 在文件中填充以下代码并保存文件

   {
   	"function": {
   		"prefix": "function",
   		"body": [
   				"/**",
   				"* @brief Function Description",
   				"*",
   				"* @param param1                       [in/out] Param Description",
   				"* @param param2                       [in/out] Param Description",
   				"*",
   				"* @return OK                        	0   success",
   				"* @return ERR               			1  	failed",
   				"*/"
   		],
   	}
   }
   

5. 保存后可以在任意.c文件中输入上述代码中prefix对应的名称function，VSCode就会自动生成body中的注释代码段
   
   

---