vscode添加python文件头模板

锦小年

发布于 2019-05-28 12:00:20

9.7K10

代码可运行

文章被收录于专栏：锦小年的博客锦小年的博客

运行总次数：0

代码可运行

pycharm可以自动生成python的文件头模板，但是vscode目前还不可以（不支持python，c的似乎有插件支持了）。琢磨了一下，可以通过用户代码片段来实现。

1. 什么是用户代码片段

参考文章说的很详细：跟我一起在Visual Studio Code 添加自定义snippet（代码段）

2. python头文件配置

之后选择python后会生成python.json,将原来内容替换为一下内容：

{
    "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  :   Rao Guangxiang ",
        "@Version :   1.0",
        "@Contact :   raogx.vip@hotmail.com",
        "@License :   (C)Copyright 2017-2018, Liugroup-NLPR-CASIA",
        "@Desc    :   None",
        
        "'''",
        "",
        "# here put the import lib",
        "$0"
    ],
    }
    
}

其中Author改为自己的，邮箱改为自己的就可以。

3. 使用方法

在.PY文件上面输入header回车就会自动生成文件头。一般输入hea就会自动联想出来，

效果图：

4. 函数注释问题

vscode里不能像pycharm在函数定义的时候输入""" 回车就能自动生成函数注释，其中包含了参数说明。这个问题该怎么解决目前还没有很好的方案，因为获取不到函数中的定义的变量名，所以不能用自定义用户片段来解决。

大家有什么好的方法希望可以一起分享哈。

添加一个函数片段代码：

 "DEF":{
        "prefix": "def",
        "body": [
        "def $1($2):",
        "    \"\"\"",
        "    param $2:",
        "    return:",
        "    \"\"\"",
        "    $0"
    ],
    }