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
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.
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:
How to reproduce it:
For example.
The text was updated successfully, but these errors were encountered: