在 VSCode 中高效配置自定义注释模板 (无需插件)

养成规范的代码注释习惯，是对每位软件开发人员的基本要求。文件、函数、表达式、变量等代码元素常常需要详尽的注释来阐明意图。通过配置 VSCode 的用户代码片段（Snippets）功能，你可以高效地添加自定义注释模板，从而显著提升注释效率。

配置步骤

1. ​​打开 VSCode。​​

2. ​​访问用户代码片段设置：​​ 点击左下角的齿轮图标（设置按钮），选择 ​​“Snippets”​​ 。

​​3. 选择目标语言文件：​​ 在弹出的列表中选择目标编程语言的配置文件（例如，为 C 语言选择 c.json，为 Python 选择 python.json）。

4. ​​配置自定义注释模板：​​ 在打开的 JSON 文件中，粘贴或编辑类似以下的自定义注释模板（你可以根据需要修改内容）：

{"HEADER": {"prefix": "header","body": ["/*******************************************************************************","  * FILENAME    : $TM_FILENAME","  * Date        : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND","  * Author      : [Your Name Here]","  * Version     : [Version Number]","  * Decription  : "," *******************************************************************************/",],}"FUNCTION": {"prefix": "function","body": ["/*******************************************************************************","  * Function name    : $TM_FILENAME","  * Description      : ","  * Parameter(in)    : ","  * Parameter(inout) : ","  * Parameter(out)   : ","  * Return value     : "," *******************************************************************************/",],}
}

​​重要提示：​​

• ​​替换占位符：​​ 务必将 [Your Name Here] 和 [Version Number] 等占位符替换为你实际的信息。
• ​​模板适应性：​​ 此模板（尤其FUNCTION部分）是一个通用示例，你需要根据项目规范或个人习惯以及编程语言的特性（如参数传递方式）进行调整。
• ​​转义字符：​​ 如果你的注释内容需要包含以下特殊字符，在模板定义时需要进行转义：
  • \n: 换行符
  • \": 双引号 (用于字符串内部)
  • \\: 反斜杠
  • \/: 正斜杠 (在需要避免被解析为正则等时)
  • \t: 制表符
  • \b: 退格符
  • \f: 换页符
  • \r: 回车符

使用自定义注释

1. 在代码编辑区域输入你定义的 prefix 值（例如输入 header 或 function）。
2. 按下 Tab 键或 Enter 键。
3. VSCode 将自动生成你配置的注释模板（如示例代码所示）。生成后，光标通常会定位到第一个需要填写具体信息的位置（如HEADER的Description后，或FUNCTION的Description后），方便你直接开始输入。使用 Tab 键可在各个占位符间跳转（如示例${1:FunctionName}定义了可编辑的占位符和跳转顺序）。