|
4 | 4 | <a href="https://marketplace.visualstudio.com/items?itemName=yCodeTech.automatic-comment-blocks"><img alt="Visual Studio Marketplace Installs" src="https://img.shields.io/visual-studio-marketplace/i/yCodeTech.automatic-comment-blocks?style=for-the-badge&label=VS%20Code%20Installs"></a> |
5 | 5 | <a href="https://open-vsx.org/extension/ycodetech/automatic-comment-blocks"><img alt="Open VSX Registry Installs" src="https://img.shields.io/open-vsx/dt/yCodeTech/automatic-comment-blocks?style=for-the-badge&label=Open%20VSX%20Downloads"></a> |
6 | 6 |
|
7 | | -A VScode extension that provides block comment completion for Javadoc-style multi-line comments and single-line comment blocks for most officially supported languages |
| 7 | +A VScode extension that provides block comment completion for Javadoc-style multi-line comments and single-line comment blocks for [_all_ supported languages](#as-of-v110-this-extension-now-automatically-adds-language-support-and-no-longer-keeps-hardcoded-language-support). |
| 8 | + |
| 9 | + |
8 | 10 |
|
9 | 11 | This is a fork of the original by [kevb34ns](https://github.com/kevb34ns/auto-comment-blocks) with lots of additional support. |
10 | 12 |
|
@@ -82,29 +84,55 @@ Press `shift + enter` while on a commented line to insert a new commented line w |
82 | 84 |
|
83 | 85 | The Language Support section shows which languages are supported. See the Settings section for how to add single-line comment support to languages that are not officially supported. |
84 | 86 |
|
| 87 | +#### Slash-style comments |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | + |
| 94 | + |
| 95 | +#### Hash-style comments |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +#### Semi-colon-style comments |
| 102 | + |
| 103 | + |
| 104 | + |
| 105 | + |
| 106 | + |
85 | 107 | ### Multi-line Comment Blocks |
86 | 108 |
|
87 | | - |
| 109 | + |
88 | 110 |
|
89 | 111 | While inside any style of the multi-line comment blocks, when pressing `enter`, the extension will insert an asterisk (`*`) at the start of every new line, and align the comment, respecting indentation. |
90 | 112 |
|
91 | 113 | #### Javadoc-style comment blocks |
92 | 114 |
|
93 | 115 | Type `/**` to start the Javadoc-style block comment, after typing the 2nd `*`, the extension will auto-close the block. |
94 | 116 |
|
| 117 | + |
| 118 | + |
95 | 119 | #### QDoc-style (Qt) comment blocks |
96 | 120 |
|
97 | 121 | Use `/*!` in all file types that support the normal `/*` comments to start a QDoc comment block; and like the Javadoc-style, the extension will auto-close the block after the `!` is typed. |
98 | 122 |
|
99 | | -#### New: Normal comment blocks |
| 123 | + |
| 124 | + |
| 125 | +#### Normal comment blocks |
100 | 126 |
|
101 | 127 | Using the normal comment block `/* */` either typing manually or the native VScode command "Toggle Block Comment" (`editor.action.blockComment`, native keybinding `shift + alt + a`), the block will have the same on enter functionality as described above. |
102 | 128 |
|
| 129 | + |
| 130 | + |
103 | 131 | ## Language Support |
104 | 132 |
|
105 | 133 | All auto-supported languages are defined in the auto-generated files found in [auto-generated-language-definitions directory](auto-generated-language-definitions) of the repo. Custom supported languages specified by user settings can also appear in these files. |
106 | 134 |
|
107 | | -These files are only for documentation purposes and are not used in the extension. |
| 135 | +These files are only for documentation purposes and debug logging. |
108 | 136 |
|
109 | 137 | Some languages that appear in the files will have been added from 3rd party language extensions. The supported languages will be different from person to person, dependant on extensions installed/enabled. |
110 | 138 |
|
|
0 commit comments