How to use JSDOC.md

How to use JSDOC

Written by Peter vd Velde

For this we need the following:

• a computer
• NodeJS installed
• and also NPM (which comes with node)

Go to your project directory and open it in your terminal and type:

npm install

Which installs jsdoc in your local project.

To generate the documentation files run:

npm run doc

After that browse to the $PROJECTFOLDER/doc/jsdoc.

For more information on how to write the documentation see already existing comments and the followong websites:

• http://usejsdoc.org/ (on how to write the documentation)
• http://ricostacruz.com/cheatsheets/jsdoc.html (a simple cheat sheet)
• https://www.youtube.com/watch?v=4meB80YjD6Y (a simple video showcasing it use with vs code)