VS Code 中配置新建 Python 文件自动添加头部注释

Posted 2021-02-21 颜十二

VS Code 中配置新建 Python 文件自动添加头部注释

参考：https://blog.csdn.net/qianbin3200896/article/details/103028261

在实际编写Python文件时，往往需要为文件添加相关说明，例如文件名称、文件作用、创建时间、作者信息、版本号等等。这些信息往往是固定模板的，因此希望有一种方式可以自动的为我们添加上这些信息。下面介绍一种在VS Code中自动为python文件添加头部注释的方法。

它的文件为：

{
    "HEADER": {
        "prefix": "header",
        "body": [
            "#!/usr/bin/env python",
            "# -*- encoding: utf-8 -*-",
            "‘‘‘",
            "@文件        :$TM_FILENAME",
            "@说明        :",
            "@时间        :$CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
            "@作者        :张三",
            "@版本        :1.0",
            "‘‘‘",
            "",
            "$0"
        ],
    }
}

我修改为：

python.json文件内容

我说通过【文件→首选项→用户代码片段→选python】进入到 python.json修改的。

之后生成 python 文件之后，输入 header 即可自动生成 注释头内容。