Document This

"Document This" is a Visual Studio Code extension that automatically generates detailed JSDoc comments for both TypeScript and JavaScript files.

Tags

Supports JSDoc and Closure Compiler tags: @class, @description, @enum, @export, @function, @implements, @interface, @param, @private, @returns or @return, @static, @template, @type, @memberOf and @date.

Options

docthis.includeTypes

When enabled, type information is added to comment tags.

Default: true

docthis.includeMemberOfOnClassMembers

When enabled, memberOf information is added to comment tags on class members.

Default: true

docthis.includeMemberOfOnInterfaceMembers

When enabled, memberOf information is added to comment tags on interface members.

Default": true

docthis.includeDescriptionTag

When enabled, JSDoc comments for functions and methods will include @description. Default: false

docthis.enableHungarianNotationEvaluation

When enabled, hungarian notation will be used as a type hint.

Default: false

docthis.inferTypesFromNames

When enabled, will use names of params & methods as type hints.

Default: false

docthis.includeAuthorTag

When enabled, will add the @author tag.

Default: false

docthis.authorName

When docthis.includeAuthorTag is enabled, will add @author tag with this value.

Default: "(Set the text for this tag by adding docthis.authorName to your settings file.)"

docthis.includeDateTag

When enabled, will add the @date tag in YYYY-MM-DD format.

Default: false

docthis.returnsTag

Put @returns in place of @returns

Default: true

List of all available formats for @date tag

Format	Output	Description
YY	18	Two-digit year
YYYY	2018	Four-digit year
M	1-12	The month, beginning at 1
MM	01-12	The month, 2-digits
MMM	Jan-Dec	The abbreviated month name
MMMM	January-December	The full month name
D	1-31	The day of the month
DD	01-31	The day of the month, 2-digits
d	0-6	The day of the week, with Sunday as 0
dd	Su-Sa	The min name of the day of the week
ddd	Sun-Sat	The short name of the day of the week
dddd	Sunday-Saturday	The name of the day of the week
H	0-23	The hour
HH	00-23	The hour, 2-digits
h	1-12	The hour, 12-hour clock
hh	01-12	The hour, 12-hour clock, 2-digits
m	0-59	The minute
mm	00-59	The minute, 2-digits
s	0-59	The second
ss	00-59	The second, 2-digits
SSS	000-999	The millisecond, 3-digits
Z	+5:00	The offset from UTC
ZZ	+0500	The offset from UTC, 2-digits
A	AM PM
a	am pm

Commands

Document This

Ctrl+Alt+D and again Ctrl+Alt+D

Generates documentation for whatever the caret is on or inside of.

Trace TypeScript Syntax Node

Prints info about the node ancestry at a given caret position.

Thank you for using Document This!