Skip to content

docs: add component comments #7376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Rich-Harris merged 3 commits into from
Dec 3, 2024
Merged

docs: add component comments #7376

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
517a35c
docs: add component comments
metonym Sep 19, 2023
c8da516
Review: copy on IDE
metonym Sep 19, 2023
19345d2
Review: conventions/brevity
metonym Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions documentation/docs/02-template-syntax/02-basic-markup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,13 @@ Comments beginning with `svelte-ignore` disable warnings for the next block of m
<!-- svelte-ignore a11y-autofocus -->
<input bind:value={name} autofocus />
```

You can document components with the `@component` tag. Component comments will appear when hovering over a component in your IDE using the [Svelte Language Server](https://github.com/sveltejs/language-tools).

```svelte
<!--
@component
This is a component description.
-->
<h1>Hello world</h1>
```