vscode 创建文件自动添加注释信息

这篇具有很好参考价值的文章主要介绍了vscode 创建文件自动添加注释信息。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

随机记录

目录

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"扩展

vscode 创建文件自动添加注释信息,vscode,ide,编辑器

2.2 设置注释信息
步骤:
1. 安装完成后,打开一个新创建的Python文件
2. 在文件的顶部行,键入3个引号 """ 并按下回车键,自动生成函数参数注释

3. 自动创建了一个多行注释块,您可以在其中填写作者、文件名、函数名等信息

vscode 创建文件自动添加注释信息,vscode,ide,编辑器

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即可自动弹出下面的注释

vscode 创建文件自动添加注释信息,vscode,ide,编辑器vscode 创建文件自动添加注释信息,vscode,ide,编辑器

vscode 创建文件自动添加注释信息,vscode,ide,编辑器

vscode 创建文件自动添加注释信息,vscode,ide,编辑器vscode 创建文件自动添加注释信息,vscode,ide,编辑器

 至此,已完成vscode 上py 文件参数注释自动生成、头文件注释自动添加功能文章来源地址https://www.toymoban.com/news/detail-819772.html

到了这里,关于vscode 创建文件自动添加注释信息的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【vscode】生成函数参数@param注释 及 自动添加头注释和函数注释

    自动添加头部、函数注释 方法一:输入/**,IDE会自动弹出完整的多行注释demo: 方法二:下载安装koroFileHeader, 一个vscode插件, 用于生成文件头部注释和函数注释的插件,效果如下: 用户设置文件settings.json,输入以下配置: 配置完成保存后, 重启vscode 完成插件环境生成。

    2024年02月13日
    浏览(58)
  • Unity 编辑器-创建模板脚本,并自动绑定属性,添加点击事件

    当使用框架开发时,Prefab挂载的很多脚本都有固定的格式。从Unity的基础模板创建cs文件,再修改到应有的模板,会浪费一些时间。尤其是有大量的不同界面时,每个都改一遍,浪费时间不说,还有可能遗漏或错改。写个脚本创建指定的模板代替C#基础模板。 注:当前脚本使用

    2024年02月13日
    浏览(63)
  • PyCharm 自动添加作者信息、创建时间等信息

    第一步 找到settings 机器学习方面问题,nc,csv,tif操作可以看作者名字q

    2024年02月16日
    浏览(41)
  • 最新的Microsoft Visual Studio新建文件自动添加注释教程

    提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 目录 前言 一、注释是什么? 二、自动添加头部注释 1.添加注释教程 第一步:找到VS安装的路径,忘记了就点击VS图标,右键属性找到起始位置。  第二步:在安装路径下继续往下找一个叫Class.cs的文件

    2024年02月04日
    浏览(81)
  • pycharm 创建python文件时添加默认信息

    1、settings - Editor - File and Code Templates - Python Script 2、添加默认格式 3、可用变量 ${PROJECT_NAME} - 当前项目的名称。 ${NAME} - 在文件创建过程中在“新建文件”对话框中指定的新文件的名称。 ${USER} - 当前用户的登录名。 ${DATE} - 当前的系统日期。 ${TIME} - 当前系统时间。 ${YEAR} - 今

    2024年02月02日
    浏览(34)
  • IDE + ChatGPT,这款编辑器真的做到可以自动写代码了

    介绍 Cursor 是集成了 GPT-4 的 IDE 工具,目前免费并且无需 API Key,支持 Win、Mac、Linux 平台,可以按要求生成代码,或者让 AI 帮助优化代码,分析代码。Cursor目前已经集成了openai的GPT-4,它或将彻底改变我们写代码的方式。 以前程序员被调侃是“CV”工程师,以后我们恐怕要成

    2023年04月25日
    浏览(53)
  • IDE /Qt Creator 文本编辑器之文件编码设置

    在 Qt Creator 工具 - 选项 - 文本编辑器 - 行为选项卡中,存在一个叫作 “文件编码” 的配置项。其默认配置如下, 我是栽了不少坑之后,才理解到它的用途和作用方式的。这是一个有用的配置项,尤其是在使用 Qt Creator + MSVC 组成的集成开发环境时。我是在整理 《IDE/warning:

    2024年02月13日
    浏览(57)
  • 系列十三、idea创建文件自动生成作者信息

            File===Settings===Editor===File and Code Templates===Includes===File Header

    2024年02月11日
    浏览(48)
  • VSCode无法从Extensions下载工具时,把工具下载到本地并添加到VSCode编辑器

    下载报错: Error while installing \\\'......\\\' extension. Please check the log for more details. 由于内网限制(或者其他网络限制)无法正常下载扩展工具到VSCode编辑器,可以把工具下载到本地再添加到VSCode编辑器来解决此类问题 进入Extensions 搜索你需要安装的拓展工具 直接点击拓展工具的名字

    2024年02月12日
    浏览(73)
  • 自动更改由VSCode调试器创建的默认launch.json文件

    File - Preference - Settings 修改下面的部分

    2024年02月20日
    浏览(43)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包