1
1
# Tutorial
2
2
3
- I needed a way to list [ codetags ] ( https://www.python.org/dev/peps/pep-0350/ ) in
4
- my project. While
3
+ I was looking for a way to standardize the creation of comments in my projects
4
+ and came across [ codetags ] ( https://www.python.org/dev/peps/pep-0350/ ) .
5
5
[ vscode-codetags] ( https://marketplace.visualstudio.com/items?itemName=cg-cnu.vscode-codetags )
6
- lets you standardizing the creation of tags you can use the extensions below to
7
- add more value to it. This guide initially written by [ Théry
6
+ is my attempt at scratching that itch. This addon helps you standardize the
7
+ creation of tags. But there is a lot of value you can gain by combining with
8
+ other extenstions. This guide, initially written by [ Théry
8
9
Fouchter] ( https://github.com/TheryFouchter ) helps you setup and list codetags
9
- with Icons and color per codetag .
10
+ with Icons and colors .
10
11
11
12
## Screenshot
12
13
@@ -18,9 +19,12 @@ You can use the below addons and its settings to create a set of custom todos
18
19
and display them in the Todo Tree and assign specific color using better
19
20
comments. Add the below configurations to settings.json
20
21
22
+ By unifying the tags, icons and colors across all the addons you get a
23
+ seamless experience.
24
+
21
25
### Code Tags
22
26
23
- You can extend tags in Code Tags by
27
+ You can extend tags in codetags by defining your own custom tags.
24
28
25
29
``` json
26
30
// Add additional codetags
@@ -66,7 +70,8 @@ You can extend tags in Code Tags by
66
70
Tree] ( https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree )
67
71
by [ Gruntfuggly] ( https://marketplace.visualstudio.com/publishers/Gruntfuggly )
68
72
lets you display all the TODOs in your project. Its an amazing addon and it can
69
- be extended to track codetags.
73
+ be extended to track codetags. You define the codetags you are using and specify
74
+ the color and icon per tag.
70
75
71
76
``` json
72
77
// (recommended) only highlight the tag due to the regex bellow
@@ -163,7 +168,8 @@ be extended to track codetags.
163
168
[ Better
164
169
Comments] ( https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments )
165
170
by [ Aaron Bond] ( https://marketplace.visualstudio.com/publishers/aaron-bond )
166
- makes your comments beautify. You can configure it to work with codetags.
171
+ makes your comments more meaningful. You can configure it to work with codetags by
172
+ setting different color for each codetag.
167
173
168
174
``` json
169
175
// The color of the line of your codetags
@@ -284,3 +290,9 @@ makes your comments beautify. You can configure it to work with codetags.
284
290
}
285
291
]
286
292
```
293
+
294
+ ## Credits
295
+
296
+ - 👏 [ Théry Fouchter] ( https://github.com/TheryFouchter )
297
+ - 👏 [ Aaron Bond] ( https://marketplace.visualstudio.com/publishers/aaron-bond )
298
+ - 👏 [ Gruntfuggly] ( https://marketplace.visualstudio.com/publishers/Gruntfuggly )
0 commit comments