Sean Walther’s Blog

JSDoc: How to document your JavaScript

JSDoc is meant to do for Javascript, what Javadoc does for Java.

It does.  

You can download and install JSDoc easily:

1. Download JSDoc
2. Expand the tgz.gz file (I use Winrar)
3. Optional – I copy the jsdoc folder to my C: drive to make things easier
4. Reminder – you need a perl runtime installed.  ActivePerl is recommended
5. Open up a command prompt 
6. Change to your JSDoc folder (mine is c:\JSDoc-1.10.2\)
7. Run it: “perl jsdoc.pl test.js” (to test it against the built in JS file)

Usage of JSDoc is as simple as Javadoc was.  An example of usage taken from the official JSDoc page is below:

/**
* Shape is an abstract base class. It is defined simply
* to have something to inherit from for geometric
* subclasses
* @constructor
*/
function Shape(color){
this.color = color;
}

// Bind the Shape_getColor method to the Shape class
Shape.prototype.getColor = Shape_getColor;

/**
* Get the name of the color for this shape
* @returns A color string for this shape
*/
function Shape_getColor(){
return this.color;
}

/**
* Circle is a subclass of Shape
*/
function Circle(radius){
this.radius = radius;
}

/**
* A very rough value for pi
*/
Circle.PI = 3.14;

/**
* Get the radius of this circle
* @returns The radius of this circle
*/
function Circle_getRadius(){
return this.radius;
}

// Circle is a subclass of Shape
Circle.prototype = new Shape(null);

 

You can use the reference on the official site to learn about more of the “@” attributes you can use for JSDoc.  

The example code is here:

• test.js – original example javascript file
• JSDoc generated documentation for the test.js file.

Related Posts

• February 7, 2010 -- Apple’s iPad / iPhone HTML5 Bet: HTML5 Drawing App Proves Capabilities (2)
  Recently I've been posting on HTML5 versus Flash.  Many people who are not familiar with HTML5 may n...
• March 25, 2009 -- How To: Track File Downloads with Google Analytics (7)
  Google Analytics is what most people use nowadays for web traffic reports.  It is flexible, powerful...
• March 10, 2009 -- How do I use transparent PNGs in IE6: Using AlphaImageLoader (0)
  Internet Explorer is a tough beast.  It was very popular years ago.  Unfortunately, it's still in us...
• February 18, 2009 -- Introduction to JSON (JavaScript Object Notation) (3)
  JSON, JavaScript Object Notation, is a very useful tool for AJAX developers (and many others I'm sur...
• January 21, 2009 -- Basic AJAX Tutorial: jQuery toggle and slide (12)
  In this tutorial we will review: Definition of AJAX Introduction to jQuery Basic document jQ...

Tags: activeperl, document, javadoc, Javascript, JSDoc, perl, winrar

No comments yet.

Leave a comment