docland
docland copied to clipboard
Class instance properties/methods should be documented
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:
- https://doc.deno.land/https://unpkg.com/[email protected]/Cache.mjs/~/default
- https://unpkg.com/[email protected]/Cache.mjs
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.