前言
为了后期维护工程方便,我们通常会在所有的代码最前面,添加一些关于这个代码文件的相关说明,内容可能包括文件名,作者,邮箱,时间等等。VS Code是一个非常强大的代码编辑器,我们可以利用自定义代码片段来实现添加标题说明的功能。下面以python文件为例展示具体方法。
解决方法
1.打开VS Code,点击文件
→首选项
→配置用户代码片段
。会跳出一个对话框,可以看到各种不同语言的配置,如下所示,我们往下拉,点击python
。
2.可以看到默认的python.json中的说明,中文意思如下所示,
在这里放置你的Python代码片段。每个代码片段都有一个名称、一个前缀、一个代码体和描述。
前缀用于触发代码片段,代码体将被扩展和插入。可能的变量有:
$1,$2表示选项卡停止, 0 表示最终光标位置, 0表示最终光标位置, 0表示最终光标位置,{1:label},${2:another}表示占位符。具有相同ID的占位符连接在一起。
示例:
“Print to console”: {
“prefix”: “log”,
“body”: [
“console.log(‘$1’);”,
“$2”
],
“description”: “Log output to console”
}
3. 我们把这些内容全部删除,然后用如下代码替换。根据上面的翻译,结合下面的代码,我们可以在创建文件时,键入title
来激活我们设置的这个默认的标题说明。
注意:在添加下面代码时,记得修改@Author和@Email后面的部分为你自己的对应内容
{
"Add python title Header": {
"prefix": "title",
"body": [
"#!/usr/bin/env python",
"# -*- coding: utf-8 -*-",
"\"\"\"",
"# @FileName : ${TM_FILENAME_BASE}",
"# @Time : ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
"# @Author : pellykoo",
"# @Email : 123456789@xxx.com",
"# @description :",
"\"\"\""
],
"description": "Add title to Python File"
}
}
4.设置结束后关闭这个文件,点击文件
→新建文件
,选择Python File
。按键Ctrl + S保存这个新建的文件,给它取名,此处我们取名new.py。回车确定。
5.在开头输入title
,按键Tab 补全即可。
总结
擅长举一反三的同学们可能就看出来了,代码片段是一个非常实用的功能,我这篇文章只是为了实现添加标题的功能,实际上我们还可以将一些常用的代码块,已经完善的一些函数,直接添加到这个python.json文件中,其他的语言也是类似操作,只要把第1步中的python,替换成java,c,cpp即可。这样可以帮助我们提高代码编写的效率,避免重复的工作。VS Code提供了一个方便的接口,让我们可以轻松地定义和使用自定义代码片段。