JavaScript API Documentation using JSDoc

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.

Share:

banner for the css playlist in hebrew life michael courses for programmers

The First Steps in CSS

Learn CSS using our our videos (in Hebrew) on the CSS (he) playlist on youtube. Do it now. Do it for free.

Good Trainers Collaborate with Others

It is always essential to keep an open mind and learn from others. This applies to everyone, including teachers and especially software development trainers. Software

The Beauty of Code

Coding is Art! Developing Code That Works is Simple. Develop Code with Style is a Challenge!

Update cookies preferences