A Visual Studio Code port of the Atom package Docblockr.
Currently three languages have been implemented:
- C
- Java
- JavaScript
- PHP
- SCSS
- TypeScript
- Vue.js
More languages will be implemented in the future.
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)
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 ///.