不使用插件,实现vscode中python文件头部注释和函数注释

vscode中python文件头部注释和函数注释

我使用过koroFileHeader插件和vscode-FileHeader插件,有时候快捷键并不会产生注释,且注释风格不甚理想。因此寻找不使用插件的方式来实现注释。

文件-首选项-用户片段-python.json
请添加图片描述
请添加图片描述
搜索python,选择python.json进行编辑,没有编辑过的会显示为python.

设置内容

{
	"HEADER": {
		"prefix": "header",
		"body": [
		"#!/usr/bin/env python",
		"# -*- encoding: utf-8 -*-",
		"'''",
		"@File         :$TM_FILENAME",
		"@Description  :",
		"@Time         :$CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
		"@Author       :flow-laic",
		"@Version      :1.0",
		"'''",
		"",
		"$0"
		],
	},

	"function":{
        "prefix": "function",
        "body": [
            "\"\"\"",
            "@Description :",
			"@Param:",
            "@Returns     :",
            "\"\"\"",
            "$0"
        ],
    }
}



设置内容可按自己的需求调整。

实现方式
1.python文件头部注释:header
请添加图片描述

2.python函数注释:function
请添加图片描述
实现效果
请添加图片描述

  • 4
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
在VS Code遇到Python代码文乱码的,可以尝试以下几种解决方法: 1. 修改文件编码:在VS Code的右下角可以看到当前文件的编码格式,默认情况下是UTF-8。如果代码文乱码,可以尝试将编码格式修改为UTF-8或者GBK等常用编码格式,以匹配代码文件的实际编码。 2. 修改VS Code的默认编码:点击VS Code左上角的"文件"菜单,选择"首选项",再选择"设置"。在设置页面搜索"files.encoding",将其值修改为UTF-8或者GBK等常用编码格式。 3. 修改Python解释器的编码:在VS Code,点击左下角的Python解释器版本,选择"Python: Select Interpreter"。在弹出的列表选择对应的Python解释器,然后点击右上角的齿轮图标,选择"配置Python"。在打开的settings.json文件,添加以下配置: "python.pythonPath": "python解释器路径", "python.envFile": "${workspaceFolder}/.env", "python.envFileParsing": "venv" 其,"python解释器路径"是你本地Python解释器的路径,可以通过在终端输入"which python"来获取。保存文件后重启VS Code。 4. 使用正确的字符编码:在Python代码,确保使用正确的字符编码方式来处理文字符。可以在代码文件开头添加以下注释来指定字符编码: # -*- coding: utf-8 -*- 如果以上方法仍然无法解决文乱码问题,请提供更具体的错误信息或代码示例,以便更好地帮助您解决问题。
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值