javascript - JSDoc setting up? -

I am not good at computers but I am trying to use JSDoc for one of my projects,

There is a tutorial for getting it up and running

I downloaded the program from Gitubo, but now I do not understand what To do. I have a bunch of files in a folder and it does not really know how it's actually running for my project.

Can someone give me step-by-step instructions on how JSDOK is actually working, how do I set it up, how do I use it?

I know that this can be worldly for some of you, but should we all start right somewhere?

Well, are you using Windows or GNU / Linux? First of all, you have to follow the default tag to markup your source code, identify your classes, methods, parameters etc. After this, you will download the file here: remove it and then on the jsdoc-master folder Go.

In it, you have a script called jsdoc (with no extensions). All you have to do is direct it to your entire path to the .js file that you want to create a document like this: ./jsdoc your_class.js Then, in a few minutes you will get the output inside the out-out folder. Open the .html file and bang!

Here you can find some common tags to use in your code (in the form of comments):

This solution is for UNIX-based systems. But, using another node (which you can run with windows, linux, mac, etc.) First of all, download nodes here:

Then take a look at the package Go to this website to enter jsdoc:

Then, go back to your terminal (after the node installed in any operating system) and type: npm install -g jsdoc option -G means global form So you have your node within the main folder of the package, and so They'll have whatever project is not for him are available and need to install it again ...

Finally, you can only use this command: jsdoc path / to / your / file.js

and so on! I hope this will help you.