From 6045028666ba6b19ab03571f123ea62fac95b642 Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Tue, 3 Dec 2024 11:07:12 -0800 Subject: [PATCH] docs: add component comments (#7376) * docs: add component comments * Review: copy on IDE Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> * Review: conventions/brevity Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> --------- Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> --- documentation/docs/02-template-syntax/02-basic-markup.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/documentation/docs/02-template-syntax/02-basic-markup.md b/documentation/docs/02-template-syntax/02-basic-markup.md index e6192230d484..401528cf7c1f 100644 --- a/documentation/docs/02-template-syntax/02-basic-markup.md +++ b/documentation/docs/02-template-syntax/02-basic-markup.md @@ -138,3 +138,12 @@ Comments beginning with `svelte-ignore` disable warnings for the next block of m ``` + +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). + +```svelte + +

Hello world

+```