Document This:提升您的代码文档化效率
Document This是一款专为TypeScript和JavaScript文件设计的Visual Studio Code扩展,旨在自动生成详细的JSDoc注释,帮助开发者提升代码文档化的效率和质量。
支持的标签:
Document This支持多种JSDoc和Closure Compiler标签,包括但不限于:@class, @description, @enum, @export, @function, @implements, @interface, @param, @private, @returns, @return, @static, @template, @type, @memberOf和@date。
自定义选项:
@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数值表示。 |
o | GMT/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,提升您的代码文档化体验!
本站所有资源都是由网友投稿发布,或转载各大下载站, 请自行检测软件的完整性!
本站所有资源仅供学习与参考,请勿用于商业用途,否则 产生的一切后果将由您自己承担!
如有侵权请联系我们删除下架,联系方式:study_golang@163.com