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 配置
jsonc
{
"vueCompilerOptions": {
"plugins": ["vue-macros/volar"],
},
}
Kevin Deng
zhiyuanzmj
Leo