【Vscode】推荐一款适用于Python的快速函数注释插件

最新推荐文章于 2024-02-29 16:12:35 发布
最新推荐文章于 2024-02-29 16:12:35 发布
阅读量1.5w 收藏 26
点赞数 19
分类专栏： vscode python 文章标签： vscode pyhton docstring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42951560/article/details/118146713
版权
python 同时被 2 个专栏收录
158 篇文章 37 订阅
订阅专栏
vscode
11 篇文章 2 订阅
订阅专栏

演示

在这里插入图片描述

安装

在这里插入图片描述

功能

  • 快速生成文档字符串 (docstring) 片段。
  • 可供选择的多种文档字符串格式。
  • 通过pep484类型提示、默认值和变量名称自动推断参数类型。
  • 支持普通参数、关键字参数、装饰器、错误和参数类型的识别。

格式

  • Google (默认)
  • docBlockr
  • Numpy
  • Sphinx
  • PEP0257 (敬请期待)

用法

光标必须位于函数定义正下方的行上，才能生成完全自动填充的文档字符串。共有如下的三种调用方式：

  • 先输入三个双引号（"""）然后回车
  • 也可以直接使用快捷键Ctrl+Shift+2调用（修改快捷键：Keyboard Shortcuts -> generateDocstring）
  • 或者右键菜单选项卡：Generate Docstring

设置

settings -> autoDocstring里面可以修改注释风格，引号风格（单引号还是双引号），注释模板等等。
在这里插入图片描述

参考

https://github.com/NilsJPWerner/autoDocstring

Xavier Jiezou
关注
  • 19
    点赞
  • 踩
  • 26
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 4
    评论
专栏目录
vscode种如何快速生成代码注释----＞如何更优雅地写代码
雪小貂的博客
03-13 485
代码写起来，更加优雅了，方便自己下次查看时能快速回忆！
Python 编程的最好搭档—VSCode 详细指南
程序员小麦的博客
11-17 558
刚学Python的同学可能会觉得每次写Python的时候都得打开Cmd有点烦躁，直接上手Pycharm的同学可能会觉得这软件太笨重了，晦涩难用。那么有没有省去打开CMD的步骤，又能弥补Pycharm笨重的特点的软件呢？——答案是**VSCode.**
Python 如何在Vscode里面添加代码注释
qq_44695769的博客
07-11 2053
作为一个全干工程师，我学过Java，C#，JS。其实语言这个东西都是一通百通的，尤其是静态语言到动态语言。静态语言和动态语言的区别就是：属性能不能变化。静态语言适合写复杂的功能，动态语言适合写简单的功能。当然这只是相对来说，只要你代码管理的好，其实差不多。硬要说差别的话就是静态语言效率会高一点。其实你只要接触过JS之后，你上手Python其实很快的，但是我还是不习惯Python的不命名直接用，感觉写多了会很容易出Bug，而且动态语言你要对作用域和代码命名有极高的敏感度，不然后面Debug会很折磨。
9款超级实用 VSCode 插件，让 Python 编程轻松愉悦
2301_78285120的博客
05-30 1万+
Python Preview是一个适用于VSCode的Python代码预览插件，可以将Python代码转换为漂亮的HTML页面，并在浏览器中进行预览。通过该插件，程序员可以在VSCode中方便地预览Python代码的运行结果和效果，提高代码开发的效率和可读性。它会自动审查和改进代码，这样就可以花更多时间专注于编写新代码，减少清理代码的时间。Python Indent是一个适用于VSCode的Python缩进插件，可以自动调整Python代码的缩进，保持代码的格式一致。TODO 代码表示未来将要进行的操作。
VSCode——Python必下的9种插件的使用感受！
最新发布
西瓜味夏天的博客
02-29 809
在使用这个插件的时候出现了一个小插曲，因为我是用远程服务器跑的代码，可能是这个原因导致本地的VSCode一打开就会出现提示：扩展主机在过去5分钟内意外终止了3次。提取函数中的参数与返回值，声明参数、参数类型、返回值等信息，但是不会根据函数整体生成概括描述。AI生成函数的概括性描述以及提取函数中的参数与返回值，声明参数、参数类型、返回值等信息。关闭这个插件就好了，如果也出现了这个问题，可以试试这个解决办法。试了试，需要一直翻着墙才能用，不然就会提示请求失败。直接就能用，不用登录，界面是这样。
如何快速地注释Python代码？
devid008的博客
03-27 4579
在 Python 中，单行注释使用“#”符号，多行注释使用三个单引号（'''）或三个双引号（"""）括起来的块。注释通常用于解释代码的目的，提供对代码的描述、解释、文档等等。
vscode自动添加头注释和函数注释
xd_wjc的博客
12-24 7779
vscode自动添加头注释和函数注释
VScode里python函数自动注释配置-autoDocstring
南瓜派三蔬
12-21 7663
1. 安装插件Python Docstring Generator 在vscode左侧extension里面输入autoDocstring,找到Python Docstring Generator，点击安装。 2. 配置Docstring Format以及快捷键 （1） 按以下路径：File —> Preferences —> Settings，找到配置参数的地方； （2） 在搜索栏输入 autoDocstring，找到 Auto Docstring: Docstring Format； （3）
VSCode中自动为Python文件添加头部注释
09-18
主要介绍了VSCode中自动为Python文件添加头部注释，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
vscode笔记（一）- vscode自动生成文件头部注释和函数注释
diaoyanbian8143的博客
02-28 1万+
VsCode 自动生成文件头部注释和函数注释 作者：狐狸家的鱼 本文链接：vscode自动生成文件头部注释和函数注释 GitHub：sueRimn 1、安装插件KoroFileHeader 2、设置 在vscode左下角点击设置按钮，选择“设置”，然后输入“fileheader”, 文件头部注释：Filehe...
python_官方编码规范/(函数)文档规范/三引号“““函数说明/注释规范/vscode文档插件
xuchaoxin1375的博客
06-20 606
文章目录python PEP:Style Guide for Python Codedocumentation strings python PEP: https://www.python.org/dev/peps/#introduction Style Guide for Python Code https://www.python.org/dev/peps/pep-0008/ documentation strings
自用vscode注释python代码快捷键
狂小虎/Anthony Dave的博客 KuangXiaoHu's Blogs
04-18 7550
选中，然后 注释 Ctrl + / 或者 Ctrl + K + C 取消注释 Ctrl + / 或者 Ctrl + K + U
vscode之python集成（一）
zuofanxiu的专栏
07-08 1万+
首先，我本人是想用vscode来写python项目的，我下载了vscode软件的python安装包    vscode直接小白式解压安装就好，至于python的安装的话只是多了一步配置环境变量，之后为了验证python开发环境是否建好，可进入cmd （任意路径下）输入python,如下则安装成功——    接下来就是，我不想直接通过命令行窗口来进行开发python项目，所以需要将python集成到...
VSCode中设置Python解释器和pylint的波浪线问题
shadow_walker的博客
02-23 5万+
VSCode中设置Python interpreterPython解释器设置为了在vscode中看到package源码，需要设置好vscode中的Python解释器路径，然后就可以点击右键—>转到定义，随意的看到package源码了，这样看package黑箱内部很方便了。1.打开设置 文件—》首选项——》设置 2.搜索python.pythonPath可以看到现在的解释器是:默认的”python
Visual Studio Code使用心得
热门推荐
jiangwei0512的博客
07-31 7万+
Visual Studio Code 使用心得。
VSCode 配置快速输入函数注释
Criss@陈磊
12-15 4328
1、进入vscode选择文件，首选项下的用户代码片段 2、弹出框输入Python后回车 3、弹出文件（python.json）输入如下内容，原有内容不要修改或者删除，加入funciton部分 "HEADER":{"prefix": "header", "body": [ "#!/usr/bin/env python", "# -*- coding: utf-8 -*-", "'''", "@File : $TM_F
vsCode设置文件注释和函数注释使用koroFileHeader插件
qq_54334713的博客
11-01 1053
安装koroFileHeader插件&快捷键不可的问题
vscode 方法代码块的注释生成方法
caixiajia的专栏
09-05 4万+
1、安装插件  Document This 2、将光标放置于function上面，快捷键是 Ctrl+Alt+D 加 Ctrl+Alt+D 注：vue里的method方法中的function用这个不行，单独的一个文件中可以，类似下面的代码 /** * * 获取指定的参数值 * @param {*} name 参数名称 */ const getUrlParam = function...
vscode的函数注释插件]
12-06
以下是介绍VSCode中的函数注释插件koroFileHeader的方法： 1. 首先，需要在VSCode中安装koroFileHeader插件。可以在VSCode的扩展商店中搜索koroFileHeader，然后点击安装即可。 2. 安装完成后，在需要添加函数注释的函数上方输入“/**”，然后按下回车键，即可自动生成函数注释。 3. 自动生成的函数注释包括函数的参数、返回值、函数说明等信息，可以根据需要进行修改。 4. 如果需要添加文件头部注释，可以在文件开头输入“/**”，然后按下回车键，即可自动生成文件头部注释。 5. 自动生成的文件头部注释包括文件名、作者、创建时间等信息，也可以根据需要进行修改。 6. koroFileHeader插件支持多种语言，包括JavaScript、Python、Java等，可以根据需要进行设置。 示例代码如下： ```python def add(a, b): """ This function adds two numbers. Parameters: a (int): The first number. b (int): The second number. Returns: int: The sum of a and b. """ return a + b ```
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Xavier Jiezou

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值