Provide a way to document Astro components, integrated with the language server

[JonasGruenwald]

Summary

It would be nice to have a standard way of documenting Astro components which the language server understands, so component documentation can be shown on hover for a given component.

Background & Motivation

When creating re-usable component within a project or components for use by others, it is useful to document the components functionality and props for reference.

Most frameworks provide ways to do this:

• In Svelte you can use HTML comments with the @component tag for this: (svelte2tsx) Allow documenting components with a tagged HTML comment sveltejs/language-tools#285
• In React, since components are just functions (or classes), documentation can be easily attached using existing standard jsdoc methods

Goals

• Provide a standard way of documenting Astro components
• Adjust the language server accordingly, so that it can show component documentation on hover

[JonasGruenwald]

Ah I suppose I missed this:
https://github.com/withastro/roadmap/blob/main/proposals/0026-component-interface.md

I'm closing this since the linked proposal was accepted