登录
Document This
分类:工具软件 访问:44 下载量:0

软件介绍

更新时间:2025-04-22

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,提升您的代码文档化体验!

本站所有资源都是由网友投稿发布,或转载各大下载站, 请自行检测软件的完整性!

本站所有资源仅供学习与参考,请勿用于商业用途,否则 产生的一切后果将由您自己承担!

如有侵权请联系我们删除下架,联系方式:study_golang@163.com

最新教程

查看更多
  • Vue.js 微实战--十天技能课堂
    Vue.js 微实战--十天技能课堂
    咨询微信:ycku_com;该课程是一门实战性质的课程,重点围绕Vue.js框架展开。课程中包含了四个小实战项目:计算器、打卡、史今查询和手机归属地。学习者将通过这些实际的小项目,学会如何使用Vue.js框架构建各种类型的应用。从简单的计算器到更复杂的打卡系统、查询功能和API调用,学习者将掌握Vue.js的核心概念、组件化开发、状态管理以及与后端API的交互。通过这些实战项目,学习者将能够获得丰
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让学生了解MySQL如何与客户端进行通信。此外,课程还将介绍如何优化MySQL的网络通信性能,包括连接池、网络压缩、SSL加密等高级技术。学生将通过实践项目,亲手
  • golang socket 编程
    golang socket 编程
    如有问题加微信:Le-studyg;本课程从基础概念讲起,涵盖了socket编程的核心概念、Golang的socket编程接口、常见协议和案例实战等内容。通过系统地学习,学员将掌握如何使用Golang进行高效的socket编程,从而为开发高性能的网络应用打下坚实的基础。
  • Golang云原生架构师课程
    Golang云原生架构师课程
    Go是一门并发支持、垃圾回收的编译型系统编程语言;本课程转载自哔哩哔哩:https://www.bilibili.com/video/BV1Mh411M7A
  • Golang深入理解GPM模型
    Golang深入理解GPM模型
    Golang深入理解GPM调度器模型及全场景分析,希望您看完这套视频有所收获;包括调度器的由来和分析、GMP模型简介、以及11个场景总结。
  • Go语言课程Gin框架实战
    Go语言课程Gin框架实战
    Gin是一个用Go(Golang)编写的HTTPweb框架。它是一个类似于 martini 但拥有更好性能的API框架,由于 httprouter,速度提高了近40倍。如果你需要极好的性能,使用Gin吧。