Essentials of Javascript - Cultural View

JSDoc 90
History
The earliest example of using a Javadoc-like syntax to document JavaScript was released in 1999 with the
Netscape/Mozilla project named Rhino [1] .
JSDoc In Use
• The JSDoc syntax has been described at length in the Apress book Foundations of Ajax ISBN 1-59059-582-3.
• IntelliJ and RubyMine understand JSDoc syntax.
• The Eclipse IDE [2] has extensions that understand the JSDoc syntax. Eclipse-based Aptana Studio supports
ScriptDoc, and the included JavaScript files are commented in ScriptDoc.
• Mozile [3] , the Mozilla Inline Editor uses JSDoc.
• The Helma [4] application framework uses JSDoc.
See also
• Comparison of documentation generators
External links
• Annotating JavaScript for the Closure Compiler [5]
• Create useful relevant JavaScript documentation with JSDoc [6]
• Javadoc Tool: How to Write Doc Comments for the Javadoc Tool [7]
Documentation generators
• JSDoc [8] - written in Perl
• JsDoc Toolkit [9] - written in JavaScript
References
[1] http://lxr.mozilla.org/mozilla/source/js/rhino/examples/jsdoc.js
[2] http://www.interaktonline.com/Products/Eclipse/JSEclipse/Features/Details/Use+of+JSDoc+and+inline+parameter+comments+to+
detect+parameter+type.html?id_ftr=639
[3] http://mozile.mozdev.org/0.8/doc/jsdoc/index.html
[4] http://helma.zumbrunn.net/reference/core/
[5] http://code.google.com/closure/compiler/docs/js-for-compiler.html
[6] http://blogs.techrepublic.com.com/programming-and-development/?p=451
[7] http://java.sun.com/j2se/javadoc/writingdoccomments/
[8] http://jsdoc.sourceforge.net/
[9] http://code.google.com/p/jsdoc-toolkit/