Documentation - abantoo/Boi-Koi GitHub Wiki
We've chosen JSdoc as or documentation tool for our project. JSDoc is a documentation generator for JS. It exports documentation in an HTML file. It integrates well with text editors. For more about JSDoc
Some basic instruction:
- Write /**...*/ to start a jsdoc comment.
- Write inside * mark to add lines in the comments.
- to Add type and description about a parmeter write in this format inside comment @param {type} varname details
- To install jsdoc using npm, write in the terminal : npm install jsdoc
- To generate documentation, go to the directory where the code is in and write in the terminal: jsdoc code.js
- In case there is a problem in linux related to directory, use jsdoc -d=directory code.js
JSdoc will generate an HTML file for the js file that will have the same name as the js file but with HTML extension, and can be found inside Out directory.
To find more tags of JSDoc, visit here