There should be basic doc strings for important, especially exported, functions.
Otherwise we might loose overview rather quickly.
Also the general idea of a file (e.g. 'what is in command.js') should be noted roughly.
There should be basic doc strings for important, especially exported, functions.
Otherwise we might loose overview rather quickly.
Also the general idea of a file (e.g. 'what is in command.js') should be noted roughly.
Maybe it is worth to look into JSDoc? It is also used by matris-js-sdk.
You make your comments in the code (where they belong) including tags if needed and afterwards you can also build a documentation out of it, which provides probably a better overview than the comments in the code itself.
Maybe it is worth to look into [JSDoc](http://usejsdoc.org/)? It is also used by matris-js-sdk.
You make your comments in the code (where they belong) including tags if needed and afterwards you can also build a documentation out of it, which provides probably a better overview than the comments in the code itself.
Also see http://usejsdoc.org/about-getting-started.html for examples
This repo is archived. You cannot comment on issues.
There should be basic doc strings for important, especially exported, functions.
Otherwise we might loose overview rather quickly.
Also the general idea of a file (e.g. 'what is in command.js') should be noted roughly.
Maybe it is worth to look into JSDoc? It is also used by matris-js-sdk.
You make your comments in the code (where they belong) including tags if needed and afterwards you can also build a documentation out of it, which provides probably a better overview than the comments in the code itself.
Also see http://usejsdoc.org/about-getting-started.html for examples