How do I use JSDoc on Windows?

问题:

Forgive me if this is a daft question but I'm utterly baffled as to how I can use JSDoc on Windows. I'm aware of JSDoc-Toolkit but it's a bit out of date and the google code repository recommends to use JSDoc 3 instead. I have downloaded JSDoc from Github and unzipped the jsdoc-master folder onto my local disk but can't find any solid information as to how to use it to parse my files.

回答1:

You can download it as an npm package for the Node.js JavaScript runtime environment.

1. Install Node.js which comes with npm
2. Open your a command line

3. Install JsDoc by typing the following command

   npm install -g jsdoc

4. Run JsDoc / generate documentation. more info

   jsdoc path/to/file.js

5. Configure jsdoc (Optional)

回答2:

Ok, so I think I figures it out. I'm not saying this is necessarily saying this is the correct way, but it worked for me. Here goes:

1) Install node.js

2) Open a command prompt

3) As a test, create a folder in your root drive (c:\test) and go to it (cd\test). I guess there was some sort of permission issue as I couldn't get the following steps to work in my desktop folder.

4) Install the JSDoc package: npm -install jsdoc

5) There should be a folder in test called node_modules

6) Go to the .bin subfolder in node_modules

7) There should be a file called jsdoc.cmd. Simple use jsdoc myfile.js in the command prompt to execute the JSDoc script on your file