VS Code自动写注释并生成文档:Mintlify Doc Writer

文章目录

    • 安装和初步使用
    • 界面说明
    • VS Code插件

安装和初步使用

Mintlify Doc Writer(后文简称MDW),是一款自动为代码写注释的AI工具,在插件栏搜索后,安装Mintlify Doc Writer for Python…,总之名字很长,安装完成后,在其支持的任何编程语言中,只要选中代码,按下快捷键Ctrl+.,就可以自动生成代码注释,示例如下

在这里插入图片描述

目前,其支持的语言和文档格式如下表所示

支持的语言文档格式
Python
JavaScript
TypeScript
JSX and TSX files
C and C++
PHP
Java
C#
Ruby
Rust
Dart
Go
JSDoc
reST
NumPy
DocBlock
Doxygen
Javadoc
GoDoc
XML
Google

界面说明

安装WDM之后,会在左侧单独开出一个图标,并提供了一些下拉框,从上到下依次是

  • GENERATE DOCS 提供了生成文档的按钮
  • DOCSTRING FORMAT 可以选择注释格式,默认自动检测
  • DOCUMENTATION PROGRESS 文档的注释进度
  • LANGUAGE 注释语言,默认是英语,可改选为Chinese
  • INVITE TEAM MEMBERS 貌似是团队协作功能,没用过
  • HOTKEY BINDING 快捷键绑定,默认是Ctrl+.,可改为Alt+.。

下面实测一段Python代码,函数下方的注释,均为WDM生成

def splitFolder(path,mark="]"):"""函数 splitFolder 将路径和标记作为输入,查找名称中带有指定标记的所有文件,根据标记之前的文件名部分创建文件夹,并将文件移动到各自的文件夹中。:param path: `path` 参数是一个字符串,表示文件所在的目录路径。它应该以反斜杠(“\”)结尾,表明它是目录路径。:param mark: “mark”参数是一个字符串,用于分割文件名和文件夹名。它在`folder =f.split(mark)[0]`行中使用来分割文件名和文件夹名。默认情况下,该标记设置为“]”,但您可以更改它, defaults to ] (optional)"""if path[-1]!='\\':path += "\\"files = getAllFiles(path,"txt")files = list(filter(markFilter(mark),files))for f in files:try:folder = f.split(mark)[0]newName = f[len(folder)+1:]mkDir(path+folder)os.rename(path+f,path+folder+'\\'+newName)except:print(f)

VS Code插件

最后推荐一些有用的VS Code插件:

  • 时间轴插件
  • csv工具
  • 用AI写代码
  • 查看Word,Excel
  • 二进制文件查看
  • draw.io画流程图

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/214693.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

亿胜盈科HT7183 16V, 3A高效升压转换器 可编程软启动

HT7183是一款高功率异步升压转换器,集成 120mΩ功率开关管,为便携式系统提供G效的小尺寸处理方案。 HT7183具有2.6V至5.5V输入电压范围,可为各类不同供电的应用提供支持。HT7183具备3A 开关电流能力,并且能够提供高达16V的输出电…

JM中ref_pic_list_modification bug记录

问题描述 今天在用JM对YUV420p编码时,发现编出的码流用ffplay播放花屏,报如下错误: JM的版本时19.1,没有使能B帧,PicOrderCntType设置为2,其它都是encoder.cfg中的默认配置。我用一些码流分析工具播放H264码流正常,用一些播放器播放也都存在花屏,不过大多数播放器都是…

坚鹏:中国邮政储蓄银行数字化转型战略、方法与案例培训

中国邮政储蓄银行拥有优良的资产质量和显著的成长潜力,是中国领先的大型零售银行。2016年9月在香港联交所挂牌上市,2019年12月在上交所挂牌上市。中国邮政储蓄银行拥有近4万个营业网点,服务个人客户超6.5亿户。2022年,在《银行家》…

C++笔记之Delegate和委托构造(Delegating constructor)

C笔记之Delegate和委托构造辨析 code review! —— 杭州 2023-12-10 文章目录 C笔记之Delegate和委托构造辨析0.有道词典:英语发音1.ChatGPT:delegate概念详解2.Delegate和“将可调用对象作为函数参数”是不是一回事?3.C的Delegate示例4.…

MySQL数据库,创建和管理表

创建数据库: 方式一:创建数据库 CREATE DATABASE 数据库名;(使用的是默认的字符集) 方式二:创建数据库并指定字符集 CREATE DATABASE 数据库名 CHARACTER SET 字符集; 方式三:判断数…

openGauss学习笔记-150 openGauss 数据库运维-备份与恢复-物理备份与恢复之gs_backup

文章目录 openGauss学习笔记-150 openGauss 数据库运维-备份与恢复-物理备份与恢复之gs_backup150.1 背景信息150.2 前提条件150.3 语法150.4 参数说明150.5 示例 openGauss学习笔记-150 openGauss 数据库运维-备份与恢复-物理备份与恢复之gs_backup 150.1 背景信息 openGaus…

解读 | GPT-4突然“变赖“ 是莫名其妙还是另有玄机

大家好,我是极智视界,欢迎关注我的公众号,获取我的更多前沿科技分享 邀您加入我的知识星球「极智视界」,星球内有超多好玩的项目实战源码和资源下载,链接:https://t.zsxq.com/0aiNxERDq 事情是这样的&#…

DSP外部中断笔记

中断原理 三部分 注意 ,外部中断使能,PIE使能,CPU中断使能 外部中断有7个,PIE有12组,一个组有8个中断复用。只有一个CPU中断可执行。 外部中断原理 1、外部中断概述 外部中断结构图 外部中断XINT1对应的是0到31GPIO…

记录一次云原生线上服务数据迁移全过程

文章目录 背景迁移方案调研迁移过程服务监控脚本定时任务暂停本地副本服务启动,在线服务下线MySQL 数据迁移Mongo 数据迁移切换新数据库 ip 本地服务启动数据库连接验证服务打包部署服务重启前端恢复正常监控脚本定时任务启动旧服务器器容器关闭 迁移总结 背景 校园…

TCP的滑动窗口机制

网络的错误检测和补偿机制非常复杂。 一、等待超时时间(返回ACK号的等待时间) 当网络繁忙时会发生拥塞,ACK号的返回变慢,较短的等待时间会导致频繁的数据重传,导致本就拥塞的网络雪上加霜。如果等待时间过长&#xf…

VC++使用GetProcessTimes获取进程创建时间、销毁时间、用户态时间、内核态时间

一、GetProcessTimes函数简介(微软MSDN) 微软提供了一个非常有用的API函数GetProcessTimes用来获取进程创建时间、销毁时间、用户态时间、内核态时间,msdn连接为:GetProcessTimes 函数 (processthreadsapi.h) 其函数原型为&#…

2022年第十一届数学建模国际赛小美赛A题翼龙如何飞行解题全过程文档及程序

2022年第十一届数学建模国际赛小美赛 A题 翼龙如何飞行 原题再现: 翼龙是翼龙目中一个已灭绝的飞行爬行动物分支。它们存在于中生代的大部分时期:从三叠纪晚期到白垩纪末期。翼龙是已知最早进化出动力飞行的脊椎动物。它们的翅膀是由皮肤、肌肉和其他组…

聚类算法的性能度量

聚类算法的性能度量 聚类算法就是根据数据中样本与样本之间的距离或相似度,将样本划分为若干组/类/簇,其划分的原则:簇内样本相似、簇间样本不相似,聚类的结果是产生一个簇的集合。 其划分方式主要分为两…

java实现网络聊天

网络聊天实现步骤(从功能谈论方法): 客户端: 1.登录面板:注册提醒用户注册格式,登录账号密码不为空,点击登录的时候需要连接服务器端,启动聊天面板。(监听用户点击登录…

Spring日志完结篇,MyBatis操作数据库(入门)

目录 Spring可以对日志进行分目录打印 日志持久化(让日志进行长期的保存) MyBatis操作数据库(优秀的持久层框架) MyBatis的写法 开发规范: 单元测试的写法 传递参数 Spring可以对日志进行分目录打印 他的意思是说spring相关只打印INFO…

Truffle的基础语法与js测试语法

truffle编译 truffle compiletruffle部署 truffle migratetruffle测试 使用test文件夹下的所有文件测试 truffle test使用单个文件 测试 truffle test 文件所在位置

机器学习算法(9)——集成技术(Bagging——随机森林分类器和回归)

一、说明 在这篇文章,我将向您解释集成技术和著名的集成技术之一,它属于装袋技术,称为随机森林分类器和回归。 集成技术是机器学习技术,它结合多个基本模块和模型来创建最佳预测模型。为了更好地理解这个定义,我们需要…

[UIM]论文解读:subword Regularization: Multiple Subword Candidates

文章目录 一、完整代码二、论文解读2.1 介绍2.2 NMT2.3 Unigram language model2.4 subword 抽样2.5 效果 三、整体总结 论文:Subword Regularization: Improving Neural Network Translation Models with Multiple Subword Candidates 作者:Taku Kudo 时…

低多边形3D建模动画风格纹理贴图

在线工具推荐: 3D数字孪生场景编辑器 - GLTF/GLB材质纹理编辑器 - 3D模型在线转换 - Three.js AI自动纹理开发包 - YOLO 虚幻合成数据生成器 - 三维模型预览图生成器 - 3D模型语义搜索引擎 当谈到游戏角色的3D模型风格时,有几种不同的风格&#xf…

什么是神经网络的非线性

大家好啊,我是董董灿。 最近在写《计算机视觉入门与调优》(右键,在新窗口中打开链接)的小册,其中一部分说到激活函数的时候,谈到了神经网络的非线性问题。 今天就一起来看看,为什么神经网络需…