docs: add component comments

[metonym]

I find @component comments to be highly useful. I actually wasn't aware it was supported by the Svelte Language Server until recently.

When visiting the documentation site, I cannot find documentation on component comments using a command + f search. Currently, component comments are only documented in the FAQs section.

This PR adds documentation for component comments to the Comments section.

[benmccann]

yep, seems like a good thing to document!

[Conduitry]

My gut instinct is that, until we have more documentation of ancillary tooling on svelte.dev, that this isn't the sort of thing that should live here. It's not part of the core Svelte language, and the compiler ignores it. If this is documented somewhere else, like in the language tools repo somewhere, I could get behind having a link to that.

I know at some point we had a vision of separate tabs on the svelte.dev site for all of the different official bits of tooling (generated in some way from markdown files in individual repos), but I'm not sure whether that's still something we see happening now that we've moved away from the centralized docs API.

unclear if/where this should land

[benmccann]

My gut instinct is that, until we have more documentation of ancillary tooling on svelte.dev, that this isn't the sort of thing that should live here.

In my mind this is part of the Svelte spec and so it does belong here. There are a number of different tools that may have to understand this syntax. Documenting it just for a single tool doesn't seem sufficient. Those tools should probably link back to docs living here instead

[changeset-bot]

⚠️ No Changeset found

Latest commit: 19345d2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[metonym]

I've rebased on master.

[Rich-Harris]

belated thanks!

[benmccann]

@metonym unfortunately this PR accidentally got merged into the svelte-4 branch, which means no one will see it. We'll need to the changes copied to main for them to actually go live. I filed an issue for that here: #14560. If you're interested, please feel free to send a PR and hopefully we can finally get this change out

[metonym]

@benmccann Thanks for the heads up. I just checked the current live Svelte docs, and it seems that documentation for @component has already been added, so perhaps we can forgo this.

https://svelte.dev/docs/svelte/basic-markup#Comments

[benmccann]

oh, great! I missed that. thanks!