配置VSCode插件 Python Docstring Generator

最新推荐文章于 2024-08-19 14:31:21 发布
最新推荐文章于 2024-08-19 14:31:21 发布
阅读量5.6k 收藏 6
点赞数 6
分类专栏： 配置
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_46184072/article/details/117899294
版权

docstring Python插件 模板配置 参数信息 autoDocstring
关键词由CSDN通过智能技术生成

听说docstring for python这个插件蛮好用的，也确实蛮好用的，可以自动生成函数注释模板信息。但我觉得官方文档有点绕，网络上也没有中文版本的文档，这里分享一下怎么配置。

配置模板文件

首先安装插件，根据官方文档autoDocstring/google.mustache at master · NilsJPWerner/autoDocstring · GitHub，需要配置一个.mustache文件。这个文件用于控制生成的注释模板。一般来说用这个模板就够了，具体看这里。github.com

 

配置路径

然后需要设置该文件的路径为customTemplatePath。在vscode中Shift+Ctrl+P，输入setting，打开设置。搜索customTemplatePath，输入文件路径即可

按shift+ctrl+2即可生成

特殊情况

值得一提的是，在另外一台电脑上，我按这个模板怎么配置都无法显示参数信息，类似这样

把模板里

{{#parametersExist}}和{{/parametersExist}}分别改成

{{#argsExist}}和{{/argsExist}}就OK了


GIS跳闸
关注
专栏目录
VScode里python函数自动注释配置-autoDocstring
南瓜派三蔬
12-21 8091
1. 安装插件Python Docstring Generator 在vscode左侧extension里面输入autoDocstring,找到Python Docstring Generator，点击安装。 2. 配置Docstring Format以及快捷键 （1） 按以下路径：File —> Preferences —> Settings，找到配置参数的地方； （2） 在搜索栏输入 autoDocstring，找到 Auto Docstring: Docstring Format； （3）
用 VS Code 写 Python，这几个插件是必装的
涛哥聊Python
04-09 1583
点击上方蓝色小字，关注“涛哥聊Python”重磅干货，第一时间送达来源:Python数据科学大家好，我是涛哥，今天给大家分享一波VS Code里几个必装插件。如果你是初学小白，建议全部...
【PyCharm使用手册】PyCharm插件详解，有这一篇就够了！！！
最新发布
2401_85855266的博客
08-19 812
PyCharm是一款功能强大的Python IDE，它提供了许多内置功能来帮助开发者提高编码效率。此外，PyCharm还支持各种插件，这些插件可以进一步扩展IDE的功能，满足开发者的特定需求。以下是一些常用的PyCharm插件，以及它们的详细说明和示例源码。
ai-docstring：Visual Studio Code扩展，可使用AI（NLP）技术为python函数快速生成文档字符串
02-03
VSCode Python AI文档字符串生成器 Visual Studio Code扩展，可使用AI（NLP）技术为python函数快速生成文档字符串。 该项目是为分叉的。 以前，功能描述必须由用户编写，但AI会看到代码并进行总结。 产品特点 AI快速生成一个可通过Tab键浏览的docstring代码段。 在几种不同类型的文档字符串格式之间进行选择。 通过pep484类型提示，默认值和var名称推断参数类型。 支持args，kwargs，修饰符，错误和参数类型 Docstring格式 Google（默认） docBlockr 脾气暴躁的 狮身人面像 PEP0257（即将推出） 用法
python docstring
我是张先生
12-10 313
def hello(): """ output 'hello' :return: """ print('hello') print(hello.__doc__) 参考
coc-pydocstring:适用于coc.nvim的doq（python docstring generator）扩展
04-06
coc-pydocstring 适用于 （python docstring generator）扩展 安装 CocInstall ： 去做 vim-plug ： Plug ' yaegassy/coc-pydocstring ' , { ' do ' : ' yarn install --frozen-lockfile ' } 笔记 快速为python生成文档字符串。 配置选项 pydocstring.enable ：启用coc-pydocstring扩展名，默认值： true pydocstring.doqPath ：（可选）doq工具的路径（绝对路径），默认值： "" pydocstring.formatter ：文档字符串格式化程序，有效选项["sphinx", "google", "numpy"] ，默认值： "sphinx" pydocstring.ignoreExc
230612-VSCode中自定义AutoDocstring模板样式
专注机器学习之路
06-12 890
删除第3行，第6行的空行，可以减少插入模板中的间距！，后续设置需要设置该模板的路径。记住该模板文件的位置。
VS Code 使用 autoDocstring 插件快速生成 python 函数的文档字符串
ayiya_Oese的博客
07-21 3001
支持自定义模板。该扩展使用 mustache.js 模板引擎。要使用自定义模板，请创建一个.mustache文件，并使用配置指定其路径。查看随附的谷歌文档字符串模板以获取使用示例。以下标记可在自定义模板中使用。变量段落{{/args}}
利用Vscode进行Python开发环境配置的步骤
09-16
在Vscode中，你还可以配置代码自动完成、智能感知等功能，通过安装其他相关的插件，如`Python Docstring Generator`用于自动生成docstrings，`Jupyter`插件用于交互式编程和Notebook支持。 最后，记得定期更新你的...
VSCode配置python环境
qq_40577131的博客
01-21 1万+
本人初学Python，从Pycharm转到了VSCode，也试着进行VSCode环境配置。 1.安装Python——Python官网 2.安装VSCode——VSCode官网，vscode下载与安装——参考这儿 在两个安装完成之后可以配置一下vscode中文环境：Ctrl+shift+X 进入商店扩展，步骤： 1.ctrl+shift+x 2.输入Chinese 3.点击install安装 退出重启 配置中文环境完成之后开始正式在vscode配置python环境 1.ctrl+shift+x进入扩展商店，输
9个python vscode 插件
JanLEE
10-09 1600
Python Snippets有大量的代码段，涵盖了所有最常见的需求，如字符串、列表、集合、元组、字典、类。所有的代码段都至少有一个例子，帮助你快速查阅和学习使用。一个可视化的python插件，帮助你更好的调试和修复bug，觉得是debug一大利器。更友好的缩进，帮助你更好的找到for,if等结束的位置，眼神不好的人的福音。帮助你管理好python中的缩进，而不是每次回车都在窗口的最左边。看到python运行结果的插件，在写一些小脚本的时候超有用！同时，帮助你自动填充括号，更好的敲代码。
VScode python 常用插件
finny7的博客
10-26 2721
这里写自定义目录标题1. Visual Studio IntelliCode2. Bracket Pair Colorizer3. autopep84. filesize5. Path Autocomplete6. Guides7. VSCode Python Docstring Generator8. SSH FS9. Remote - SSH python和语言是必装的插件这里就不添加进去了，主要说几个用起来不错的插件。 1. Visual Studio IntelliCode 非常快的代码提示速度插件
这四个VSCode插件可以大幅提升Python开发效率
weixin_42731853的博客
10-20 2412
作为一个数据科学家，拥有良好的编码惯例非常重要，这样可以让同事更容易地阅读和理解你的代码，避免混淆。 为了让代码易于理解，应该做到以下几点： 类型提示 代码文档 仅保留有用的变量，函数和包 突出显示代码中需要改进的部分 避免琐碎的错误 VSCode是我最喜欢的IDE，在这篇文章中，我将介绍4个插件，它们能帮助我们实现以上提出的几点原则，提升代码质量。 Python Type Hint 类型提示明确指出变量的数据类型，当调用函数或类时，“提示”程序员应该提供什么类型的参数。 例如下面的函数，明确指出参数是
飘逸的python - 代码即文档docstring
热门推荐
mattkang
07-10 2万+
什么是docstring在软件工程中，其实编码所占的部分是非常小的，大多是其它的事情，比如写文档。文档是沟通的工具。 在python中，比较推崇在代码中写文档，代码即文档，比较方便，容易维护，直观，一致。 代码写完，文档也出来了。其实Markdown也差不多这种思想，文本写完，排版也完成了。 看看PEP 0257中对docstring的定义： A docstring is a string
Python的docstring规范（说明文档的规范写法）
啷个哩个啷
11-22 2万+
其实，标准规范里，python代码写完都要进行规范性测试。 比如： black . # 帮你添加空格，看起来好看 flake8 # 检查不规范的地方 然后会检查出代码不规范的地方，进而修改，比如下面这样的 ✨ 1. python dostring规范 ...
VS Code - 自动生成代码注释
Talk is cheap. Show me the code
11-26 3343
VS Code - 自动生成代码注释 VS Code - 自动生成代码注释 代码注释在软件的迭代过程中举足轻重，所以一个规范化的代码注释也非常重要，在用 VS Code 中则可以使用插件来规范化代码注释。在 VS Code 插件选项中搜索 autoDocstring 然后 Install 安装即可使用。在 Python 代码函数下输入英文下的三个冒号，然后回车。
vscode python
思维缜密的博客
12-05 727
插件 我装了 Python Python Docstring Generator Python Environment Manager Python Indent Visual Studio IntelliCode(这个应该都有） 这几个插件 代码片段 然后 设置->User Snippets(中文好像是用户代码片段） 选py 然后配置 prefix是打出来的前缀 body是打出来的片段，里面每一个元素占一行 { "HEADER":{ "prefix": "head", "body"
探索高效编码的秘密：`autoDocstring` - 自动化文档字符串生成工具
gitblog_00075的博客
04-15 537
探索高效编码的秘密：autoDocstring - 自动化文档字符串生成工具 autoDocstringVSCode extension that generates docstrings for python files项目地址:https://gitcode.com/gh_mirrors/au/autoDocstring 在编程世界里，良好的注释和文档字符串是代码可读性和维护性的关键。而今天...
vscode自定义vue模板快设置
Seven71111的博客
11-13 834
文件 - 首选项 - 用户代码片段 - 输入vue - 选择vue.json 模板需要json格式。 copy模板： { // Place your snippets for vue here. Each snippet is defined under a snippet name and has a prefix, body and // description. The pre...
vscode配置python需要什么插件
03-27
作为AI语言模型，我建议你安装以下插件： 1. Python 2. Python Docstring Generator 3. Python Test Explorer 4. Pylance 5. Python Preview 6. Python Indent 7. Python Language Server 这些插件可以提供更好的代码编辑和调试体验。当然，具体的插件选择还要根据个人的需求和习惯来决定。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

GIS跳闸

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

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

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

打赏作者

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

抵扣说明：

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

余额充值