KaptajnKold
KaptajnKold

Reputation: 10946

How to document Vue Single-File Components that use the Composition API?

Without relying on a third party package, what is the "correct" way to document my Vue 3 Single-File Components using the Composition API in a way that allows an IDE (in my case JetBrains' IntelliJ IDEA) to show e.g. documentation pop-ups, when I hover over the name of the component in a file that depends on it?

The challenge is that there is no explicit exports in a SFC that uses the Composition API.

I've tried adding a jsdoc comment at the top of the setup script (above its imports), but that did not work.

Upvotes: 5

Views: 315

Answers (0)

Related Questions