vscode-docthis - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #typescript #go #machine-learning #docker #java #windows #awesome #mcp #openai #open-source

vscode-docthis

(★ 296)

JSDoc generator extension for Visual Studio Code.

File Explorer

Download Latest Version (.zip)

- launch.json
- settings.json
- tasks.json
- openurl.d.ts
- serialize-error.d.ts
- demo.gif
- icon.png
- documenter.ts
- extension.ts
- languageServiceHost.ts
- utilities.ts
- largeFile.ts
.gitignore
.travis.yml
.vscodeignore
CHANGELOG.md
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
tslint.json

# Installation Guide

1. Get the code

git clone https://github.com/joelday/vscode-docthis

Downloads the entire project code from GitHub to your computer.

cd vscode-docthis

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/joelday/vscode-docthis.svg?branch=master)](https://travis-ci.org/joelday/vscode-docthis) [![Paypal Donations](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&amp;business=7YU9WH4ANAB4Q&amp;lc=US&amp;item_name=Document%20This&amp;item_number=vscode-docthis%20extension&amp;currency_code=USD&amp;bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted)

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

![Demo](https://raw.githubusercontent.com/joelday/vscode-docthis/master/images/demo.gif)

# 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!