需求
- 想在vscode 中快速添加头部注释和函数注释
- 一些重复率较高的代码不想每次都码一遍
方案
上述的问题很容易解决,在vscode中提供了代码片段这个功能,代码片段这个功能入口在vscode中左下角的齿轮符号中 具体路径为Manage -> User Snippets -> python.json
,打开文件后再注释后添加下面的自定义代码片段即可,关于第一个需求,可以通过在代码片段中添加下面几行代码解决:
"HEADER":{
"prefix": "header",
"body": [
"# -*- encoding: utf-8 -*-",
"'''",
"Author : you name ",
"Time : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
"Contact : you_email_address@qq.com",
"'''",
"",
"# here put the import lib",
"$0"
],
},
关于第二个问题,打开文件这个功能我比较常用,我可以这样写,
"读文件": {
"prefix": "file",
"body": [
"with open(${1:文件全路径}) as 文件:",
"\t内容 = 文件.read()"
],
"description": "读取某文件"
定义完了代码片段后,可以直接到py文件中输入关键字(这个关键字就是你在定义代码片段中的prefix
),这个片段就会有相应的提示,之后选择相应的代码片段即可。
参考文章
1.https://zhuanlan.zhihu.com/p/56035257