Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ability to write prop documentation like JSDocs #1692

Closed
mesqueeb opened this issue Jan 31, 2020 · 1 comment
Closed

ability to write prop documentation like JSDocs #1692

mesqueeb opened this issue Jan 31, 2020 · 1 comment
Labels

Comments

@mesqueeb
Copy link

mesqueeb commented Jan 31, 2020

  • [v] I have searched through existing issues
  • [v] I have read through docs
  • [v] I have read FAQ

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:
image

@octref
Copy link
Member

octref commented Feb 10, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants