Documantation tools - NazmulMahadi/cse327 GitHub Wiki

JSDoc

What is JSDoc?

JSDoc is a documentation generator that is used for the Javascript language, we can compare it with Javadoc (JAVA) or PHPDocumentor (PHP) among others, JSDoc what it does is analyze all the Javascript code and automatically generates a static page (HTML) with All the documentation. JSDoc is easy to integrate with any IDE or Code Editor.

  • JSDoc provides a way to document Javascript source code
  • It can be exported to a HTML file for reference
  • It integrates really well with text editors/IDES.

Installation of JSDoc

To use JSDoc you need to download and install it. This can be done by means of a NodeJs packet driver called NPM, by executing the following command in the terminal.

npm install -g jsdoc

When we execute the previous command, we perform the installation of JSDoc globally (-g), in case it is necessary to install it locally (that is, in a specific project) it must be saved in its respective package.json, to do this we execute the following command.

npm install --save-dev jsdoc

Installation process:

Follow the steps to install jsdoc given below in the link.

How to install JSDoc?

Using of JsDoc Follow the steps showed in the YouTube Video below to have an idea about how to generate documentation from javascript source codes using “JSDoc” documentation tool (Link Given):

How To Use JSDoc !!

Source Code Documentation Example

1

HTML Document

2

⚠️ **GitHub.com Fallback** ⚠️