visual-studio-code - 是否有标准的方法来记录 Svelte 组件？

Question

我来自 JavaDocs 的世界，喜欢在具有一定复杂性后处理完全注释的应用程序的 DX。

能够通过一些简短的文档悬停并查看组件的所有 Prop (和隐含类型)将为我节省很多时间，而不必打开并阅读整个组件。更好的是，像使用 JavaDocs 一样运行一个命令来生成一个文档站点将是愚蠢的!

是否有围绕创建 SvelteDocs 的标准或工具？我浏览了 VS Code 市场，没有看到任何与 Svelte 相关的文档工具。

Answer 1

我偶然发现了这个问题，为我一直在使用的悬停/窥视文档方法寻找更深入的文档。似乎它没有很好的文档记录(具有讽刺意味)但它是 Svelte 语言工具的一部分，我已经将它与 Svelte 一起用于 VS Code 一段时间，所以我确信在某个时候有更多文档。它在您的组件中的使用方式如下。我记得在某处读到它需要成为组件中的第一件事，但我再也找不到那个来源了。

<!--
  @component

  some markdown here
-->

由于某些原因，我能找到的唯一文档是 here .但它提供了非常好的 Markdown 支持，因此您可以为您的组件制作一些非常有用的悬停/查看文档。