<commit_before><img src="images/icon.svg" width="128" />

# Document This
This Visual Studio Code extension automatically generates detailed JSDoc comments for both TypeScript and JavaScript files.

# Functionality
"Document This" generates thorough JSDoc comments with support for @class, @constant, @enum, @exports, @function, @implements, @interface, @param, @private, @returns, @static and @type.

# Commands
## Document This (`Windows: Ctrl-Shift-D Ctrl-Shift-D, Mac: Cmd-Shift-D Cmd-Shift-D`)
Generates documentation for whatever the carat is on or inside of.
## Document Everything (`Windows: Ctrl-Shift-D Ctrl-Shift-E, Mac: Cmd-Shift-D Cmd-Shift-E`)
Generates documentation for everything in the document that is supported by the extension.
## Document Everything Visible (`Windows: Ctrl-Shift-D Ctrl-Shift-D, Mac: Cmd-Shift-D Cmd-Shift-D`)
Generates documentation for everything in the document that is supported by the extension.

![Demo](images/demo.gif)<commit_msg>Updating readme.<commit_after><img src="https://raw.githubusercontent.com/joelday/vscode-docthis/master/images/icon.svg" width="128" />

# Document This
This Visual Studio Code extension automatically generates detailed JSDoc comments for both TypeScript and JavaScript files.

![](images/demo.gif)

# Functionality
"Document This" generates thorough JSDoc comments with support for @class, @constant, @enum, @exports, @function, @implements, @interface, @param, @private, @returns, @static and @type.

# Commands
## Document This
(`Windows: Ctrl-Shift-D Ctrl-Shift-D, Mac: Cmd-Shift-D Cmd-Shift-D`)

Generates documentation for whatever the carat is on or inside of.
## Document Everything
(`Windows: Ctrl-Shift-D Ctrl-Shift-E, Mac: Cmd-Shift-D Cmd-Shift-E`)

Generates documentation for all symbols that are supported by the extension.
## Document Everything Visible
(`Windows: Ctrl-Shift-D Ctrl-Shift-V, Mac: Cmd-Shift-D Cmd-Shift-V`)

Generates documentation for exported, public and protected symbols in the document.
{'fraction_non_alphanumeric': 0.11005502751375688, 'fraction_numerical': 0.0030015007503751876, 'mean_word_length': 5.349206349206349, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1905536', 'n_tokens_mistral': 588, 'n_tokens_neox': 563, 'n_words': 212}