Friday

Installing & Configuring JSDoc On Windows

SlashdotAdd to Technorati Favorites

This short tutorial will teach you how to install JSDoc on Windows.

JSDOC is a Javascript documentation generator tool. You add formatted comments inside your javascript code, JSDOC takes all the commented javascript code as input and generates javadoc style documentation using those comments. For more details on how to use JSDOC visit http://jsdoc.sourceforge.net/.

DISCLAIMER: I have made every attempt to present accurate information, but I cannot guarantee that inaccuracies will not occur. I (the author) will not be held responsible for any claim, loss, damage or inconvenience caused as a result of any information found on this website (blog).

Lets do the installation and configuration step-by-step
  1. JSDoc is a perl script, so in order to execute JSDoc you have to install a perl interpreter. JSDoc documentation recommends ActivePerl for Windows users.
  2. Download the latest version of ActivePerl from http://www.activestate.com. Install ActivePerl on your windows machine.
  3. Download JSDoc from http://sourceforge.net/projects/jsdoc.
  4. Extract the downloaded zip file (above) in any folder.
  5. Now, in order to run JSDoc using ActivePerl you have to install HTML-Template package for ActivePerl.
  6. Assuming that you installed ActivePerl in c:\perl, go to c:\perl\bin and execute the command ‘ppm’.
  7. ppm is a package manager for ActivePerl. The command ‘ppm’ will open up a window showing you a list of all available packages. Give it sometime to download data from the Internet.
  8. Click on the button that reads “View All Packages” from the leftmost corner of the toolbar (or type Ctrl + 1 together).
  9. You’ll see a complete list of all packages. Scroll down to find HTML-Template. Once you find this package right click on it and click on install. This package will be marked for installation.
  10. Now, you have to install the package that you just marked. Click on the button that reads “Run marked actions” (green colored arrow pointing towards right) or type Ctrl + Enter together.
  11. You’re done. ActivePerl is setup properly to run JSDoc.
  12. Now, assuming that you’re inside the ActivePerl bin (c:\perl\bin) folder and you had extracted jsdoc zip file in f:\jsdoc you’ll run the command below to generate the documentation for a test javascript script file that comes with JSDoc.
perl f:\jsdoc\jsdoc.pl F:\jsdoc\test.js

Thats it.
Documentation will be created inside the bin folder of ActivePerl in a folder named js_docs_out (JSDoc creates the output in js_docs_out folder in the folder where you run the jsdoc script from).

Labels: , , , ,

12 Comments:

At March 12, 2007 at 3:42:00 AM PDT , Blogger Mubbashir said...

Hi Shaharyaar, this is mubbashir. I wanted to ask u whether JSDoc can extract comments from aspx files.
Thanx in advace.
Mubbashir Ahmed

 
At March 16, 2007 at 9:44:00 AM PDT , Blogger Shahryar Ghazi said...

Hi Mubashir,

Sorry for the late reply I was busy with some other asisgnments.

I haven't used JSDoc with aspx files but inside .php files it works.

Thanks

 
At April 9, 2009 at 1:48:00 AM PDT , Anonymous Online Marketing Company said...

Hi Friend,

Nice to see your Blog.....I Like you Blog.
I am also interested in latest news, sometimes i posted on my blog.....

 
At March 8, 2010 at 3:17:00 AM PST , Anonymous Joomla Web Designers said...

I was looking for this from a long time & finally I got it through this article.Thanks for such a nice information.

 
At March 15, 2010 at 6:54:00 AM PDT , Anonymous CustomWebDesign@$200 said...

Excellent web development

 
At March 31, 2010 at 10:05:00 PM PDT , Anonymous Laptop Repair said...

JSDoc segfaults! What should I do?

 
At April 7, 2010 at 4:39:00 AM PDT , Anonymous Joomla Website Developer said...

Well quiet a nice & informative blog.I was wondering for a long time to search one for installing JSDoc on windows but was not able to find it exactly. This article tells step by step process to install.Thanks for sharing.

 
At September 5, 2010 at 9:56:00 PM PDT , Anonymous Web Development said...

There has been a lot of positive comments about your blog. Continue doing a good job.

 
At November 12, 2010 at 3:15:00 AM PST , Anonymous SEO Agency said...

I've been using JSDoc for all my wed design and it's perfect. It enable my job become easy.

 
At May 13, 2011 at 11:50:00 PM PDT , Anonymous Data Entry India said...

This comment has been removed by a blog administrator.

 
At November 7, 2011 at 11:43:00 PM PST , Anonymous joomla development said...

Several things in here' haven't considered before.Thank you for making this type of awesome publish that is really perfectly written, is going to be mentioning lots of buddies relating to this. Maintain blogging.

 
At November 8, 2011 at 10:54:00 AM PST , Anonymous Therapist New York said...

Wonderful information, thank you for sharing this! Hopefully it will work

-June

 

Post a Comment

Subscribe to Post Comments [Atom]

<< Home