Home » JS Resources Utilities Script Details

JSDoc - JavaScript Documentation Tool


JSDoc is a tool that parses inline documentation in JavaScript source files, and produces an documentation of the JavaScript code. This is typically in the form of HTML (example), but XML and XMI (UML) export are also supported. JSDoc is based on the (very successful) javadoc tool that was created for the same purpose for the Java programming language.

JSDoc is primarily intended for libraries of object-oriented JavaScript files, although it also works with procedural code. There is a basic ability to determine inheritance built into the parser, although some more obscure dynamic constructs will not be understood (for example, defining a method to set one class as the superclass of another).

Anyone familiar with the javadoc tool will be able to use JSDoc right away; for anyone else it is a very simple matter to get started. JSDoc picks up on comments that are opened with a slash followed by two stars (/**), and closed with the typical star-slash (*/).

Browsers Compatibility:
IE, FF, Opera, Safari
Visit Download
  1 week 2 week 1 month 5 months 1 year 2 year Overall
Votes 0 0 0 0 0 0 1
Rating 0 0 0 0 0 0 4.0
Added: Mon Aug 14 2006 Last Modify: Mon Aug 14 2006
Added by: Send Feedback to:

Page Visited Visited: 0

Add commentAdd comment (Comments: 0)  



Related Resources

Other Resources