Overview Q & A Rating & Review
Document This Core
"Document This Core" is a Visual Studio Code extension that automatically generates detailed docs-core comments for both TypeScript and JavaScript files. It is based on "Document This" by joelday and altered to use triple forward-slash style comments.
Supports docs-core and Closure Compiler tags:
@access, @author, @description, @name, @page, @param, @property, @readonly, @returns, and @type.
Commands
Command Name
Keybinding
Description
Document This
Ctrl+Alt+D + Ctrl+Alt+DAttempts to generate documentation for the subsequent line
Document This File
Ctrl+Alt+D + Ctrl+Alt+FInserts file level documentation for the current file
Commands can also be found on the context menu.
Configuration
Setting Name
Type
Default
Description
docthiscore.includeTypes
boolean
true
When enabled, type information is added to comment tags
docthiscore.includeDescriptionTag
boolean
false
When enabled, JSDoc comments for functions and methods will include @description
docthiscore.enableHungarianNotationEvaluation
boolean
false
When enabled, hungarian notation will be used as a type hint
docthiscore.inferTypesFromNames
boolean
false
When enabled, will use names of params & methods as type hints
docthiscore.includeAuthorTag
boolean
false
When enabled, will add the @author tag
docthiscore.authorName
string
-
When docthiscore.includeAuthorTag is enabled, will add @author tag with this value
docthiscore.documentNewFile
boolean
false
When enabled, new files targeted by docthiscore.documentNewFileGlob will be created with a file level comment block
docthiscore.documentNewFileGlob
string
**/*.{ts,js}
A glob that determines which new files are documented. docthiscore.documentNewFile must be enabled
