setupJsdoc

稳定性: 稳定

在 script setup 块里定义组件的 JSDoc。

Features	Supported
Volar Plugin	✅

基本用法

vue

<script setup lang="tsx">
import Comp
 from './Comp.vue'
</script>

<template>
  <Comp
 />
</template>

有两个地方可以去定义

script setup 代码块的第一行.

vue

<script setup lang="ts">
/**
 * @example
 * ```vue
 * <Comp :foo="1" />
 * ```
 */

defineProps<{
  foo: number
}>()
</script>

在 export default 表达式的上面.

TIP

这个特性依赖于 exportRender，并确保 exportRender 没有被禁用。

vue

<script setup lang="tsx">
defineProps<{
  foo: number
}>()

/**
 * @example
 * ```vue
 * <Comp :foo="1" />
 * ```
 */
export default <div />
</script>

Volar 配置

tsconfig.json

jsonc

{
  "vueCompilerOptions": {
    "plugins": ["unplugin-vue-macros/volar"],
  },
}

贡献者

Kevin Deng

zhiyuanzmj

Leo

页面历史

最后编辑于 3 个月前

查看完整历史

setupJsdoc ​

基本用法 ​

有两个地方可以去定义 ​

Volar 配置 ​

贡献者

页面历史

setupJsdoc

基本用法

有两个地方可以去定义

Volar 配置