随机记录
目录
1. 背景介绍
2. "Docstring Generator"扩展
2.1 安装
2.2 设置注释信息
3. 自动配置py 文件头注释
1. 背景介绍
在VS Code中,您可以使用扩展来为新创建的Python文件自动添加头部注释信息。有几个常用的扩展可以实现此功能,如
- "Docstring Generator"
- "Docstring"
- "autoDecstring"
2. "Docstring Generator"扩展
2.1 安装
步骤:
1. 在VS Code中打开扩展面板(快捷键为Ctrl+Shift+X)
2. 搜索并安装"Docstring Generator"扩展
2.2 设置注释信息
步骤:
1. 安装完成后,打开一个新创建的Python文件
2. 在文件的顶部行,键入3个引号 """ 并按下回车键,自动生成函数参数注释
3. 自动创建了一个多行注释块,您可以在其中填写作者、文件名、函数名等信息
3. 自动配置py 文件头注释
步骤:
1. 依次单击菜单栏 “File”—“Preferences”—“User Snippets” --> 'python' 选择python后会生成python.json文件,将该文件内容替换为以下内容:
"HEADER": {
"prefix": "header",
"body": [
"#!/usr/bin/env python",
"# -*- encoding: utf-8 -*-",
"'''",
"@文件 :$TM_FILENAME",
"@说明 :",
"@时间 :$CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
"@作者 :magx",
"@版本 :1.0",
"'''",
"",
"$0"
],
}
2. 保存修改即可。
新建一个python文件,然后在头部敲入header即可自动弹出下面的注释
文章来源:https://www.toymoban.com/news/detail-819772.html
至此,已完成vscode 上py 文件参数注释自动生成、头文件注释自动添加功能文章来源地址https://www.toymoban.com/news/detail-819772.html
到了这里,关于vscode 创建文件自动添加注释信息的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!