JSDoc

---

An API documentation generator for JavaScript.

JSDoc

Hello Stackers.. today we talking about Documenting our source code, and many of us using JS/TS for projects. So this will hope us to represent our code in our Projects

Quickstart

JSDoc supports stable versions of Node.js 12.0.0 and later. You can install JSDoc globally or in your project’s node_modules folder.

To install the latest version on npm globally (might require sudo; learn how to fix this):

npm install -g jsdoc

To install the latest version on npm locally and save it in your package’s package.json file:

npm install --save-dev jsdoc

By default, the generated documentation is saved in a directory named out. You can use the --destination (-d) option to specify another directory.

Run jsdoc --help for a complete list of command-line options.

Okay, that’s All.. for the full docs please refer to here.. cyaa..