docland icon indicating copy to clipboard operation
docland copied to clipboard

Class instance properties/methods should be documented

Open jaydenseric opened this issue 4 years ago • 1 comments

If a class has instance properties or methods created within the constructor, they should be documented but currently are not.

For example, the Cache class instance property store should be documented:

Screen Shot 2022-01-21 at 3 26 03 pm

jaydenseric avatar Jan 21 '22 04:01 jaydenseric

This is difficult, as it requires interpreting what occurs at runtime, versus static analysis of the type definitions. We have limited capabilities to infer type information from things like property initialisers, but anything further is a challenge.

There is a reason type definitions (.d.ts) files are a better way to express type information about JavaScript code.

kitsonk avatar Jan 21 '22 04:01 kitsonk