04.11.2015 Views

javascript

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Appendix B: JavaScript Tools<br />

Dojo Object Harness ( DOH )<br />

The Dojo Object Harness (DOH) began as the internal unit - testing tool for Dojo before being released for<br />

everyone to use. As with the other frameworks, unit tests are run inside the browser. The documentation for<br />

DOH lags far behind that for JsUnit and YUI Test, because it is newer to the general web -development<br />

community. Until more documentation is available, DOH may be more difficult to use than the other options.<br />

Price : Free<br />

Web site : http://www.dojotoolkit.org/<br />

Documentation Generators<br />

Most IDEs include documentation generators for the primary language. Since JavaScript has no official<br />

IDE, documentation has traditionally been done by hand or through repurposing documentation<br />

generators for other languages. However, there are now documentation generators specifically targeted<br />

at JavaScript.<br />

JsDoc Toolkit<br />

The JsDoc Toolkit was one of the first JavaScript documentation generators. It requires you to enter<br />

Javadoc - like comments into the source code, which are then processed and output as HTML files. You<br />

can customize the format of the HTML using one of the prebuilt JsDoc templates or you can create your<br />

own. The JsDoc Toolkit is available as a Java package.<br />

YUI Doc<br />

Price : Free<br />

Web site : http://www.jsdoctoolkit.org<br />

YUI Doc is YUI’s documentation generator. The generator is written in Python, so it requires a Python<br />

runtime environment to be installed. YUI Doc outputs HTML files with integrated property and method<br />

searches implemented using the YUI ’ s Autocomplete widget. As with JsDoc, YUI Doc requires Javadoc -<br />

like comments to be inserted into the source code. The default HTML can be changed through the<br />

modification of the default HTML template file and associated style sheet.<br />

AjaxDoc<br />

Price : Free<br />

Web site : http://developer.yahoo.com/yui/yuidoc/<br />

The goal of AjaxDoc is slightly different than that of the previous generators. Instead of creating HTML<br />

files for JavaScript documentation, it creates XML files in the same format as those created for .NET<br />

languages, such as C# and Visual Basic .NET. Doing so allows standard .NET documentation generators<br />

to create documentation as HTML files. AjaxDoc requires a format of documentation comments that is<br />

770

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!