How to document a Component inside "script setup" blocks?
See original GitHub issueHi there!
How to document it? Slots, props and events are working fine. But how to set the basic Component description?
<script setup lang="ts">
/**
* This should show up somewhere.
*/
...
</script>
Issue Analytics
- State:
- Created a year ago
- Comments:11 (4 by maintainers)
Top Results From Across the Web
<script setup> | Vue.js
To opt-in to the syntax, add the setup attribute to the <script> block: ... The code inside is compiled as the content of...
Read more >The 101 guide to Script Setup in Vue 3 - VueDose
Don't you know about Script Setup yet? Check out this short article now and learn the nicest way to define a Vue component...
Read more >Vue 3.2 - Using Composition API with Script Setup
Within the script block, we export an object with three keys: name, computed, and methods. If you are familiar with Vue, this should...
Read more >Explaining The New script setup Type in Vue 3 - LearnVue
<script setup>import HelloWorld from './components/HelloWorld.vue'// This starter template is using Vue 3 experimental <script setup> SFCs// ...
Read more >Using Script Setup for Vue 3 - Azilen Technologies
The <script setup> block will execute every time an instance of a component gets created. We can organize the code as per the...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I didn’t go too much further and just went with this in the configs. To also not need to do much processing, I went with this style of doc for the component:
FYI for us, the
<docs>...</docs>
block worked fine with a vite plugin: