Vue DocBlocker 2.1.0
VueDocBlocker是一款专为Vue开发者设计的扩展工具,旨在通过自动生成和完成文档块(DocBlock)来提高代码文档的效率和质量。无论您是新手还是经验丰富的开发者,VueDocBlocker都能帮助您更快、更准确地编写文档。主要功能:自动补全:在类、函数或类属性上方输入/**后,自动生成DocBlock代码片段。DocBlock连续输入:在DocBlock中按下Enter键时,自
功能介绍
Vue DocBlocker是一款专为Vue开发者设计的扩展工具,旨在通过自动生成和完成文档块(DocBlock)来提高代码文档的效率和质量。无论您是新手还是经验丰富的开发者,Vue DocBlocker都能帮助您更快、更准确地编写文档。
主要功能:
- 自动补全: 在类、函数或类属性上方输入/**后,自动生成DocBlock代码片段。
- DocBlock连续输入: 在DocBlock中按下Enter键时,自动继续文档块的输入。
- 标签补全: 支持自动完成常用的DocBlock标签,如@param、@return和@throws。
- 类型推断: 从函数签名中推断参数和返回值类型,减少手动输入的工作量。
- 模板配置: 允许用户为不同类型的DocBlock配置自定义模板,以满足个性化需求。
配置选项:
Vue DocBlocker提供了丰富的配置选项,让您可以根据自己的需求调整文档生成的细节:
- vue-docblocker.gap:控制描述和标签之间的间隔。
- vue-docblocker.returnGap:在参数和返回值标签之间添加间隔。
- vue-docblocker.returnVoid:控制是否自动添加void返回类型。
- vue-docblocker.extra:添加额外的自定义标签。
- vue-docblocker.useShortNames:选择使用短类型名称或完整类型名称。
- vue-docblocker.qualifyClassNames:根据命名空间使用语句自动限定类名。
- vue-docblocker.author:设置默认作者标签。
- vue-docblocker.functionTemplate、vue-docblocker.propertyTemplate、vue-docblocker.classTemplate:自定义函数、属性和类的DocBlock模板。
模板自定义:
通过调整模板配置,您可以控制DocBlock的输出顺序和间隔设置。默认的函数模板配置如下:
{
"message": {},
"param": {},
"return": {},
"extra": {}
}
您可以根据需要添加间隔或自定义标签。例如:
{
"message": {
"gapAfter": true
},
"extra": {},
"param": {
"gapBefore": true
}
}
支持的DocBlock标签:
Vue DocBlocker支持多种DocBlock标签,帮助您详细描述代码的功能和用途。常用标签包括:
- @param:描述函数参数
- @return:描述函数返回值
- @throws:描述可能抛出的异常
- @author:标识代码作者
通过Vue DocBlocker,您可以轻松生成符合标准的代码文档,提升开发效率和代码可读性。无论是团队合作还是个人项目,这款工具都能让您的Vue开发过程更加顺畅。
版本声明
本文转载于:https://marketplace.visualstudio.com/items?itemName=BoWarren46.vue-docblocker 如有侵犯,请联系study_golang@163.com删除
更多
相关下载
查看更多
课程推荐
-
- Golang云原生架构师课程
- Go是一门并发支持、垃圾回收的编译型系统编程语言;本课程转载自哔哩哔哩:https://www.bilibili.com/video/BV1Mh411M7A
- 204次学习
-
- MySQL数据管理之备份恢复案例解析视频教程
- 《MySQL数据管理之备份恢复案例解析视频教程》MySQL是一个开放源码的小型关联式数据库管理系统,目前MySQL被广泛地应用在Internet上的中小型网站中。由于其体积小、速度快、总体拥有成本低,尤其是开放源码这一特点,许多中小型网站为了降低网站总体拥有成本而选择了MySQL作为网站数据库。
- 160次学习
-
- MySQL索引优化解决方案
- 本套课程是根据MySQL索引的设计理念与数据结构、索引使用场景、索引分类、索引运用场景、索引性能分析、查询优化、MySQL索引的慢查询等组成,主要讲述了MySQL索引优化的解决方案,非常适合有MySQL使用基础或者有一定工作经验的同学。课程讲解了解决大数量查询慢的问题、如何编写一个高效的SQL、查询语句应该如何优化、索引的实现原理是什么、索引又应该如何优化...等诸多SQL索引优化的难点和面试点。
- 182次学习
-
- 极客学院Docker视频教程
- Docker是PaaS提供商dotCloud开源的一个基于LXC的高级容器引擎,源代码托管在Github上,基于go语言并遵从Apache2.0协议开源。Docker自2013年以来非常火热,无论是从github上的代码活跃度,还是各大厂商的支持,都使Docker成为了时下最受关注的技术,甚至微软都声称在下一代WindowsServer中集成对Docker的支持。所以我们收集了《极客学院Docke
- 243次学习
-
- Golang进阶实战编程
- 本课程是在《Go语言基础视频》基础之上录制的,是Go语言基础的后半部分。包括包的管理,IO操作,Go语言最大的亮点:高并发,goroutine,channel,反射等。本视频主要为了帮助Go语言的初学者,从零到一的快速入门。学完本套课程,可以学会如果通过包管理Go项目,并发模型,以及并发实现,channel通道如何传递数据,反射等等。
- 127次学习
-
- JavaScript极速入门
- 本套课程将帮助大家迅速掌握JavaScript这门高端的、动态的、弱类型编程语言。知识点简单明了,让你学习0压力,适合新手观看学习......
- 431次学习
查看更多
相关文章
-
- Golangmap实践及实现原理解析
- 2022-12-28 505浏览
-
- GoLand调式动态执行代码
- 2023-01-13 502浏览
-
- 试了下Golang实现try catch的方法
- 2022-12-27 502浏览
-
- 用Nginx反向代理部署go写的网站。
- 2023-01-17 502浏览
-
- MySQL主从切换的超详细步骤
- 2023-01-01 501浏览
-
- Mysql-普通索引的 change buffer
- 2023-01-25 501浏览