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

Improve jsdocs type information #3085

Open
yakanechi opened this issue Apr 3, 2024 · 0 comments
Open

Improve jsdocs type information #3085

yakanechi opened this issue Apr 3, 2024 · 0 comments

Comments

@yakanechi
Copy link
Contributor

yakanechi commented Apr 3, 2024

What happened:
Sometimes the type information in jsdoc is not enough to actually write the code.
For example, there are many object types used in this project that have a fixed key and value type.
However, in the definitions of function params and returns in docs often only "object" is used, which is inconvenient.
It is also useful to have element type information such as Array<string> for array and promise.

Also, even for class fields, it is difficult to recognize variables that are not initialized inside the class, so we think that tags such as @property should be used to tie them to the class itself.

What you expected to happen:

  • Type information is more detailed.
  • The type definition shows if it is a variable that can also be undefined type.
  • All possible variable information is available from the location of class definition.

How to reproduce it:
For example.

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

No branches or pull requests

1 participant