当前位置:首页 > 下载列表 > Document This

Document This 0.8.2

DocumentThis:提升您的代码文档化效率DocumentThis是一款专为TypeScript和JavaScript文件设计的VisualStudioCode扩展,旨在自动生成详细的JSDoc注释,帮助开发者提升代码文档化的效率和质量。支持的标签:DocumentThis支持多种JSDoc和ClosureCompiler标签,包括但不限于:@class,@descriptio
分类:   下载/工具 · 工具软件 来源:  点击进入 版本:  0.8.2
日期:  2025-04-24 人气:   大小:  
标签:   javascript keybindings
点击下载 相关下载
功能介绍

Build StatusPaypal Donations

Document This:提升您的代码文档化效率

Document This是一款专为TypeScript和JavaScript文件设计的Visual Studio Code扩展,旨在自动生成详细的JSDoc注释,帮助开发者提升代码文档化的效率和质量。

Demo

支持的标签:

Document This支持多种JSDoc和Closure Compiler标签,包括但不限于:@class, @description, @enum, @export, @function, @implements, @interface, @param, @private, @returns, @return, @static, @template, @type, @memberOf和@date。

自定义选项:

  • docthis.includeTypes:启用后,注释标签中将包含类型信息。默认值:true
  • docthis.includeMemberOfOnClassMembers:启用后,类成员的注释标签中将包含memberOf信息。默认值:true
  • docthis.includeMemberOfOnInterfaceMembers:启用后,接口成员的注释标签中将包含memberOf信息。默认值:true
  • docthis.includeDescriptionTag:启用后,函数和方法的JSDoc注释将包含@description。默认值:false
  • docthis.enableHungarianNotationEvaluation:启用后,将使用Hungarian符号作为类型提示。默认值:false
  • docthis.inferTypesFromNames:启用后,将使用参数和方法的名称作为类型提示。默认值:false
  • docthis.includeAuthorTag:启用后,将添加@author标签。默认值:false
  • docthis.authorName:当docthis.includeAuthorTag启用时,将使用此值添加@author标签。默认值:"(Set the text for this tag by adding docthis.authorName to your settings file.)"
  • docthis.includeDateTag:启用后,将以dd-mm-yyyy格式添加@date标签。默认值:false
  • docthis.returnsTag:将@returns替换为@return。默认值:false

@date标签的可用格式:

掩码描述
d月份中的天数,单个数字前不加零。
dd月份中的天数,单个数字前加零。
ddd星期几的三字母缩写。
dddd星期几的全名。
m月份,单个数字前不加零。
mm月份,单个数字前加零。
mmm月份的三字母缩写。
mmmm月份的全名。
yy年份的后两位数字,少于10的年份前加零。
yyyy用四位数字表示的年份。
h小时,单个数字前不加零(12小时制)。
hh小时,单个数字前加零(12小时制)。
H小时,单个数字前不加零(24小时制)。
HH小时,单个数字前加零(24小时制)。
M分钟,单个数字前不加零。
MM分钟,单个数字前加零。
N星期几的ISO 8601数值表示。
oGMT/UTC时区偏移量,例如 -0500 或 0230。
s秒,单个数字前不加零。
ss秒,单个数字前加零。
S日期的序数后缀(st, nd, rd, 或 th)。与d配合使用效果较好。
l毫秒,提供3位数字。
L毫秒,提供2位数字。
t小写,单字符时间标记字符串:a或p。
tt小写,两字符时间标记字符串:am或pm。
T大写,单字符时间标记字符串:A或P。
TT大写,两字符时间标记字符串:AM或PM。
W年份中的ISO 8601周数,例如42。
Z美国时区缩写,例如EST或MDT。在非美国时区或在...
'...', "..."文字字符序列。周围的引号会被删除。
UTC:必须是掩码的前四个字符。将日期从本地时间转换为UTC/GMT/Zulu时间,然后应用掩码。"UTC:"前缀会被删除。

命令:

  • Document This(Ctrl Alt D):生成光标所在或内部的文档。
  • Trace TypeScript Syntax Node:打印给定光标位置的节点祖先信息。

感谢您使用Document This,提升您的代码文档化体验!

版本声明
本文转载于:https://marketplace.visualstudio.com/items?itemName=oouo-diogo-perdigao.docthis 如有侵犯,请联系study_golang@163.com删除
查看更多
课程推荐
  • Golang云原生架构师课程
    Golang云原生架构师课程
    Go是一门并发支持、垃圾回收的编译型系统编程语言;本课程转载自哔哩哔哩:https://www.bilibili.com/video/BV1Mh411M7A
    204次学习
  • MySQL数据管理之备份恢复案例解析视频教程
    MySQL数据管理之备份恢复案例解析视频教程
    《MySQL数据管理之备份恢复案例解析视频教程》MySQL是一个开放源码的小型关联式数据库管理系统,目前MySQL被广泛地应用在Internet上的中小型网站中。由于其体积小、速度快、总体拥有成本低,尤其是开放源码这一特点,许多中小型网站为了降低网站总体拥有成本而选择了MySQL作为网站数据库。
    160次学习
  • MySQL索引优化解决方案
    MySQL索引优化解决方案
    本套课程是根据MySQL索引的设计理念与数据结构、索引使用场景、索引分类、索引运用场景、索引性能分析、查询优化、MySQL索引的慢查询等组成,主要讲述了MySQL索引优化的解决方案,非常适合有MySQL使用基础或者有一定工作经验的同学。课程讲解了解决大数量查询慢的问题、如何编写一个高效的SQL、查询语句应该如何优化、索引的实现原理是什么、索引又应该如何优化...等诸多SQL索引优化的难点和面试点。
    182次学习
  • 极客学院Docker视频教程
    极客学院Docker视频教程
    Docker是PaaS提供商dotCloud开源的一个基于LXC的高级容器引擎,源代码托管在Github上,基于go语言并遵从Apache2.0协议开源。Docker自2013年以来非常火热,无论是从github上的代码活跃度,还是各大厂商的支持,都使Docker成为了时下最受关注的技术,甚至微软都声称在下一代WindowsServer中集成对Docker的支持。所以我们收集了《极客学院Docke
    243次学习
  • Golang进阶实战编程
    Golang进阶实战编程
    本课程是在《Go语言基础视频》基础之上录制的,是Go语言基础的后半部分。包括包的管理,IO操作,Go语言最大的亮点:高并发,goroutine,channel,反射等。本视频主要为了帮助Go语言的初学者,从零到一的快速入门。学完本套课程,可以学会如果通过包管理Go项目,并发模型,以及并发实现,channel通道如何传递数据,反射等等。
    127次学习
  • JavaScript极速入门
    JavaScript极速入门
    本套课程将帮助大家迅速掌握JavaScript这门高端的、动态的、弱类型编程语言。知识点简单明了,让你学习0压力,适合新手观看学习......
    431次学习
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码