Skip to content

Commit fadcff5

Browse files
authored
docs(readme): add a "VScode Required Settings" section.
- Added a section to document the VScode settings that are required to allow the extension to work. The only setting is: `"editor.autoIndent": "advanced"` If it's set to `"brackets"` then multi-line comments will break on enter and just add an empty new line instead of continuing the `*`: `/** * [press enter here] */`
1 parent f383ad1 commit fadcff5

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ View the extension on [VScode Marketplace](https://marketplace.visualstudio.com/
2323
</td>
2424
<td>
2525

26+
[VScode Required Settings](#vscode-required-settings)
27+
28+
</td>
29+
<td>
30+
2631
[Single-line Comment Blocks](#single-line-comment-blocks)
2732

2833
</td>
@@ -79,6 +84,12 @@ For a full list of auto-supported VScode default languages, please view the auto
7984

8085
View the [Changelog](/CHANGELOG.md) for more detailed changes/additions/removals.
8186

87+
## VScode Required Settings
88+
89+
These VScode settings are required to allow the extension to work correctly. So please make sure to change them accordingly.
90+
91+
- `"editor.autoIndent": "advanced"`
92+
8293
## Usage
8394

8495
### Single-line Comment Blocks

0 commit comments

Comments
 (0)