It is currently very painful to have to go to the docs / code to recall what the parameters to a function is. It would be much better to have the different parameters (at least) hinted, and even better if the "required" parameters were actually inputed automatically.
This feature is partially done on the backend, you have the possibility to attach function definitions via the setFunctionMetadataProvider method in the DM.
I also built a prototype using JSDoc comments as Metadata which worked great.
var jsdoc = require('jsdoc-api')
// ...
jsdoc
.explain({ files: [__dirname + '/functions.js'] })
.then(docs => {
// use setFunctionMetadataProvider
})
It is currently very painful to have to go to the docs / code to recall what the parameters to a function is. It would be much better to have the different parameters (at least) hinted, and even better if the "required" parameters were actually inputed automatically.
This feature is partially done on the backend, you have the possibility to attach function definitions via the
setFunctionMetadataProvider
method in the DM.I also built a prototype using JSDoc comments as Metadata which worked great.