vscode快捷注释

一、注释格式为：

    /*
     *@Author: 张三
     *@Date: 时间为当前时间
     *@Description: 
     */

二、详细步骤如下：

1、创建自定义代码片段：

a、打开用户代码片段文件：

• 打开 VSCode，并按下 Ctrl+Shift+P（Windows/Linux）或 Cmd+Shift+P（Mac）调出命令面板。
• 输入 Preferences: Configure User Snippets 并选择该选项。

b、选择文件类型：

• 选择你想要创建代码片段的语言。例如，如果你想在 JavaScript 文件中使用这个注释模板，选择 javascript.json。

c、添加代码片段：

• 在打开的 JSON 文件中，添加你的自定义代码片段。以下是一个示例，假设你正在为 JavaScript 创建代码片段：

{
  "File Upload Comment": {
    "prefix": "fileupload",
    "body": [
      "/*",
      " *@Author: ${1:张三}",
      " *@Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
      " *@Description: ${2:文件上传}",
      " */"
    ],
    "description": "Insert file upload comment"
  }
}

• prefix 是触发代码片段的快捷方式。在此示例中，当你输入 fileupload 并按 Tab 键时，代码片段将被插入。
• body 是代码片段的内容。${1:张三} 表示这是第一个占位符，初始值为 张三；${2:文件上传} 是第二个占位符，初始值为 文件上传。${CURRENT_YEAR}, ${CURRENT_MONTH}, ${CURRENT_DATE}, ${CURRENT_HOUR}, ${CURRENT_MINUTE}, ${CURRENT_SECOND} 是内置变量，用于自动填充当前日期和时间。

e、保存文件：

• 保存 javascript.json 文件（或其他相应语言的 JSON 文件）。

2、使用自定义代码片段

a、打开你的代码文件：

• 打开一个 JavaScript 文件（或者你设置代码片段的其它语言文件）。

b、插入代码片段：

• 输入 fileupload，然后按 Tab 键。你将看到代码片段被插入，并且可以按顺序填写每个占位符。

3、示例

当你在 JavaScript 文件中输入 fileupload 并按 Tab 键后，插入的代码将如下所示：

/*
 *@Author: 张三
 *@Date: 2024-06-13 17:55:21
 *@Description: 文件上传
 */

你可以通过按 Tab 键在占位符之间切换并进行编辑。这样可以极大地提高编写注释的效率。

通过上述步骤，你可以在 VSCode 中轻松创建和使用自定义的注释模板。