如何评论VueJs单文件组件

Question

我正在编写一个 VueJs 应用程序，并且对于我的单文件组件（SFC），大部分已切换到 Vue 的新脚本设置语法。我不知道如何编写正确显示在 VSCode 的智能感知中的注释。

我想评论我的 SFC 组件，包括组件本身的“整体”评论。

以前，在没有设置语法的情况下，我做了：

/** Displays a track's artist info.....
 * @remarks This component ....
 */
export default defineComponent({
    name: 'ArtistInfo',

这也不太有效，但是当鼠标悬停在 default 关键字上时，文本实际上显示在 VSCode 智能感知预览

内部

组件本身中：

在使用 SFC 组件的代码中，它无法从外部工作。无论如何，无论是否使用设置语法，它都只是给出通用的使用提示：

现在有了新的脚本设置语法，没有明显的地方可以将注释放在第一位。

问题：我应该在哪里使用脚本设置语法为 SFC 放置组件级注释？并且：需要什么才能让 VSCode 的智能感知在使用时显示它？

注意

• 我已经按照此处推荐的方式安装了 Volar 扩展：https://stackoverflow.com/a/76441150/79485但它也不起作用（仅适用于属性等，..不适用于组件本身）

Answer 1

我正在写下我如何在代码中进行注释，这在 VS 代码中完美工作。

1. 组件级评论

2. 功能评论

3. 道具评论

如有任何疑问，请随时发表评论。 :)