Skip to content

Commit 9e7a7d3

Browse files
committed
docs(readme): add new gifs demo-ing the different comment styles.
Also change some wording.
1 parent a376ba7 commit 9e7a7d3

12 files changed

+32
-4
lines changed

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
<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>&nbsp;&nbsp;
55
<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>
66

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+
![auto-block-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/auto-comment-blocks.gif)
810

911
This is a fork of the original by [kevb34ns](https://github.com/kevb34ns/auto-comment-blocks) with lots of additional support.
1012

@@ -82,29 +84,55 @@ Press `shift + enter` while on a commented line to insert a new commented line w
8284

8385
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.
8486

87+
#### Slash-style comments
88+
89+
![slash-style-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/slash-style-comments.gif)
90+
91+
![triple-slash-style-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/triple-slash-style-comments.gif)
92+
93+
![qdoc-style-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/qdoc-style-comments.gif)
94+
95+
#### Hash-style comments
96+
97+
![hash-style-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/hash-style-comments.gif)
98+
99+
![double-hash-style-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/double-hash-style-comments.gif)
100+
101+
#### Semi-colon-style comments
102+
103+
![semi-colon-style-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/semi-colon-style-comments.gif)
104+
105+
![double-semi-colon-style-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/double-semi-colon-style-comments.gif)
106+
85107
### Multi-line Comment Blocks
86108

87-
![Demo](https://raw.githubusercontent.com/kevinkyang/auto-comment-blocks/master/img/demo.gif)
109+
![Demo](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/demo.gif)
88110

89111
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.
90112

91113
#### Javadoc-style comment blocks
92114

93115
Type `/**` to start the Javadoc-style block comment, after typing the 2nd `*`, the extension will auto-close the block.
94116

117+
![javadoc-style-block-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/javadoc-style-block-comments.gif)
118+
95119
#### QDoc-style (Qt) comment blocks
96120

97121
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.
98122

99-
#### New: Normal comment blocks
123+
![qdoc-style-block-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/qdoc-style-block-comments.gif)
124+
125+
#### Normal comment blocks
100126

101127
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.
102128

129+
![block-comments](https://raw.githubusercontent.com/yCodeTech/auto-comment-blocks/master/img/block-comments.gif)
130+
103131
## Language Support
104132

105133
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.
106134

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.
108136

109137
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.
110138

img/auto-comment-blocks.gif

850 KB
Loading

img/block-comments.gif

20.8 KB
Loading

img/double-hash-style-comments.gif

26.2 KB
Loading
37.3 KB
Loading

img/hash-style-comments.gif

25.9 KB
Loading
49.1 KB
Loading

img/qdoc-style-block-comments.gif

46.1 KB
Loading

img/qdoc-style-comments.gif

44.3 KB
Loading

img/semi-colon-style-comments.gif

34.8 KB
Loading

0 commit comments

Comments
 (0)