vscode添加python文件头模板

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

1. 什么是用户代码片段

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

2. python头文件配置

 

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

 1 {
 2     "HEADER":{
 3         "prefix": "header",
 4         "body": [
 5         "#!/usr/bin/env python",
 6         "# -*- encoding: utf-8 -*-",
 7         "'''",
 8         "@File    :   $TM_FILENAME",
 9         "@Time    :   $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
10         "@Author  :   Rao Guangxiang ",
11         "@Version :   1.0",
12         "@Contact :   raogx.vip@hotmail.com",
13         "@License :   (C)Copyright 2017-2018, Liugroup-NLPR-CASIA",
14         "@Desc    :   None",
15         
16         "'''",
17         "",
18         "# here put the import lib",
19         "$0"
20     ],
21     }
22     
23 }

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

3. 使用方法

在.PY文件上面输入header回车就会自动生成文件头。一般输入hea就会自动联想出来,
在这里插入图片描述
效果图:

4. 函数注释问题

vscode里不能像pycharm在函数定义的时候输入""" 回车就能自动生成函数注释,其中包含了参数说明。这个问题该怎么解决目前还没有很好的方案,因为获取不到函数中的定义的变量名,所以不能用自定义用户片段来解决。
大家有什么好的方法希望可以一起分享哈。
添加一个函数片段代码:

 1  "DEF":{
 2         "prefix": "def",
 3         "body": [
 4         "def $1($2):",
 5         "    """",
 6         "    param $2:",
 7         "    return:",
 8         "    """",
 9         "    $0"
10     ],
11     }

因为无法根据变量的个数来修改下面param的行数,所以就不知道有几个变量

来源:https://blog.csdn.net/jinxiaonian11/article/details/83542696

原文地址:https://www.cnblogs.com/liuyanhang/p/13753354.html