我正在用 TypeScript 構建一個 Vue 庫。我想匯出組件的檔案，就像處理普通函式一樣。
以前我們會這樣做：
<script>
/**
* This is the documentation of my component.
*/
export default {
}
</script>
<template></template>
但現在有了script setup：
<script setup lang="ts">
</script>
<template></template>
我們如何記錄組件？
uj5u.com熱心網友回復：
隨著<script setup>您不能在組件匯出上使用 JSDoc。
它是一個編譯器語法糖，可以匯出 setup 函式，因此您顯然不能注釋編譯器“生成”的函式。
如果你真的需要 JSDoc，你應該使用常規<script>with export default defineComponent:)
<script>
import { defineComponent } from 'vue'
/** This is my nice component documentation */
export default defineComponent({
name: 'MyComponent',
})
</script>
也適用于經典物件定義：
<script>
import { defineComponent } from 'vue'
/** This is my nice component documentation */
export default {
name: 'MyComponent',
}
</script>
編輯：正如@EstusFlask 在評論中提到的那樣，您可以在 SFC 組件上混合使用兩者（請參閱<script setup>檔案），因此您可以使用常規腳本來公開您的 JSDoc。<script>
<script setup>
// component setup. Takes priority over the eventual `setup()` function of the export object in <script>.
</script>
<script>
/** This is my nice component documentation */
export default {
name: 'MyComponent',
}
</script>
轉載請註明出處，本文鏈接：https://www.uj5u.com/qiye/464717.html