When developing a new library in JavaScript it would make things simpler for others if we also create a document that explains how to use the library we developed and how to use each and every function it includes. Such document, also known as API Documentation, can be easily created using the JSDoc tool.

The following video clip explains hot to install JSDoc on your computer. Please note that you must have the npm utility (part of node.js) installed in advance.

The following video clip shows how simple it is to use this library for creating API documentation for our code.

You can find more info about using this library in the Introduction to JSDoc course I have recently developed. You can find its free (for personal use) community version available at http://abelski.lifemichael.com.

Leave a Reply

Your email address will not be published. Required fields are marked *