You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
---
|
|
|
|
|
question: How do I document my components?
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
In editors which use the Svelte Language Server you can document Components, functions and exports using specially formatted comments.
|
|
|
|
|
|
|
|
|
|
````sv
|
|
|
|
|
<script>
|
|
|
|
|
/** What should we call the user? */
|
|
|
|
|
export let name = 'world';
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
@component
|
|
|
|
|
Here's some documentation for this component.
|
|
|
|
|
It will show up on hover.
|
|
|
|
|
|
|
|
|
|
- You can use markdown here.
|
|
|
|
|
- You can also use code blocks here.
|
|
|
|
|
- Usage:
|
|
|
|
|
```tsx
|
|
|
|
|
<main name="Arethra">
|
|
|
|
|
```
|
|
|
|
|
-->
|
|
|
|
|
<main>
|
|
|
|
|
<h1>
|
|
|
|
|
Hello, {name}
|
|
|
|
|
</h1>
|
|
|
|
|
</main>
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
Note: The `@component` is necessary in the HTML comment which describes your component.
|
