vscode snippets配置python头部注释

1. 首先点击右下角的管理（齿轮形状的），选择其中的用户代码片段

image.png

2. 选择现有的python代码片段python.json

image.png

3. 然后添加以下内容

image.png

{
    "HEADER": {
        "prefix": "header",
        "body": [
          "#!/usr/bin/env python",
          "# -*- encoding: utf-8 -*-",
          "'''",
          "@File    : $TM_FILENAME",
          "@Time    : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
          "@Author  : Jesse Chang",
          "@Contact : jessechang2358@gmail.com",
          "@Version : 0.1",
          "@License : Apache License Version 2.0, January 2004",
          "@Desc    : None",
          "'''",
          "",
          "$0"
        ],
      }
}

使用方法：在代码的头部输入header按回车就会自动生成头部注释

这是最终效果：

image.png

变量(Variables)

使用 $name 或者 ${name|default} 可以插入变量的值，如果变量未被赋值则插入 default 的值或者空值 。当变量未被定义，则将变量名插入，变量(Variables)将被转换为占位符(Placeholders)
系统变量如下

• TM_SELECTED_TEXT 当前选定的文本或空字符串
• TM_CURRENT_LINE 当前行的内容
• TM_CURRENT_WORD 光标下的单词的内容或空字符串
• TM_LINE_INDEX 基于零索引的行号
• TM_LINE_NUMBER 基于一索引的行号
• TM_FILENAME 当前文档的文件名
• TM_FILENAME_BASE 当前文档的文件名（不含后缀名)
• TM_DIRECTORY 当前文档的目录
• TM_FILEPATH当前文档的完整文件路径
• CLIPBOARD 剪切板里的内容

插入当前日期或时间：

• CURRENT_YEAR 当前年(四位数)
• CURRENT_YEAR_SHORT 当前年(两位数)
• CURRENT_MONTH 当前月
• CURRENT_MONTH_NAME 本月的全名（’七月’）
• CURRENT_MONTH_NAME_SHORT 月份的简称（’Jul’）
• CURRENT_DATE 当前日
• CURRENT_DAY_NAME 当天的名称（’星期一’）
• CURRENT_DAY_NAME_SHORT 当天的短名称（’Mon’）
• CURRENT_HOUR 当前小时
• CURRENT_MINUTE 当前分钟
• CURRENT_SECOND 当前秒

当前语言的行注释或块注释:

• BLOCK_COMMENT_START 块注释开始标识,如 PHP /*或 HTML `
• BLOCK_COMMENT_END 块注释结束标识,如 PHP */或 HTML -->
• LINE_COMMENT 行注释，如： PHP // 或 HTML ``

参考资料

vscode 自定义代码片段
Snippets in Visual Studio Code