Skip to content

Commit c8504b0

Browse files
committed
docs: add note about @component
1 parent 4b802db commit c8504b0

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

documentation/docs/03-template-syntax/01-basic-markup.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,3 +211,12 @@ You can add a special comment starting with `@component` that will show up when
211211
</h1>
212212
</main>
213213
````
214+
215+
You can document components with the `@component` tag. These comments will appear when hovering over a component in IDEs with support such as VS Code with [the Svelte VS Code extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
216+
217+
```svelte
218+
<!--
219+
@component this is a component description
220+
-->
221+
<h1>Hello world</h1>
222+
```

0 commit comments

Comments
 (0)