https://github.com/jeremyvii/vs-docblockr
DocBlockr for Visual Studio Code
https://github.com/jeremyvii/vs-docblockr
docblock docblocker docblockr javascript php typescript visual-studio-code
Last synced: 28 days ago
JSON representation
DocBlockr for Visual Studio Code
- Host: GitHub
- URL: https://github.com/jeremyvii/vs-docblockr
- Owner: jeremyvii
- License: lgpl-3.0
- Created: 2018-01-02T03:39:40.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T19:51:03.000Z (about 1 year ago)
- Last Synced: 2025-09-18T14:41:14.302Z (6 months ago)
- Topics: docblock, docblocker, docblockr, javascript, php, typescript, visual-studio-code
- Language: TypeScript
- Homepage:
- Size: 1.57 MB
- Stars: 22
- Watchers: 1
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VS DocBlockr (Visual Studio Code)
[](https://github.com/jeremyvii/vs-docblockr/releases/latest)
[](https://marketplace.visualstudio.com/items?itemName=jeremyljackson.vs-docblock)
A Visual Studio Code port of the Atom package [Docblockr](https://github.com/nikhilkalige/docblockr).
[Extension page](https://marketplace.visualstudio.com/items?itemName=jeremyljackson.vs-docblock)
Currently three languages have been implemented:
* C
* Java
* JavaScript
* PHP
* SCSS
* TypeScript
* Vue.js
More languages will be implemented in the future.
## Usage
Type `/**` above the code you want to apply a docblock too, and press `enter`.
The `Render from selection` command is also available in the command palette.
This command can also be used to parse code that spans multiple lines. (Note:
you autocomplete multiple lines with the `/**` keybinding)
## Settings
Currently the following configuration settings have been implemented:
| Title | Description |
|--------------------------|----------------------------------------------------------------------------------------------------------------------|
| Align Tags | Whether or not to automatically align the parameters, return, or variable tags. |
| Block Comment Style | Which doc block comment style to use (`default\|drupal\|tsdoc`). |
| Column Spacing | Minimum number of spaces between columns. |
| New Lines Between Tags | Whether or not to add new lines between tags. |
| Default return tag | Whether or not to display a return tag. |
| \*SCSS Comment Close | Type of block level comment closing to use. **Deprecated: Use `vs-docblockr.commentClose` targeting SCSS instead** |
| \*SCSS Comment Open | Type of block level comment opening to use. **Deprecated: Use `vs-docblockr.commentOpen` targeting SCSS instead** |
| \*SCSS Comment Separator | Type of block level separator closing to use. **Deprecated: Use `vs-docblockr.separator` targeting SCSS instead** |
| Comment Open | Type of block level comment opening to use. |
| Comment Close | Type of block level comment closing to use. |
| Separator | Type of block level separator closing to use. |
\* *Note: VS DocBlockr does not currently support autocompletion of SASS blocks with `///`.*