You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
So I often write actual descriptions along with my props, that when I come back in a few months, I easily understand what the props do.
I was just thinking, it would be cool if there could be a standard way to add documentation / an explanation sentence to props, just like JSDocs, and then maybe vetur can show that documentation when the dev typed the prop name or when he hovers over the prop name in a template.
BTW: For now I'm using actual strings for them because I use those to generate actual JSON documentation on each component I make:
The text was updated successfully, but these errors were encountered:
You should follow up in vuejs/vue#7186. Until we have a standardized format, there isn't much I can do. Or you can follow #1364, which we use internally for getting descriptions bound to tag completions.
So I often write actual descriptions along with my props, that when I come back in a few months, I easily understand what the props do.
I was just thinking, it would be cool if there could be a standard way to add documentation / an explanation sentence to props, just like JSDocs, and then maybe vetur can show that documentation when the dev typed the prop name or when he hovers over the prop name in a template.
BTW: For now I'm using actual strings for them because I use those to generate actual JSON documentation on each component I make:

The text was updated successfully, but these errors were encountered: