JSDoc

src: i.ytimg.com

JSDoc is a markup language used to annotate JavaScript source code files. Using comments containing JSDoc, programmers can add documentation describing the application programming interface of the code they're creating. This is then processed, by various tools, to produce documentation in accessible formats like HTML and Rich Text Format.

Video JSDoc

History

The earliest example of using a Javadoc-like syntax to document JavaScript was released in 1999 with the Netscape/Mozilla project Rhino, a JavaScript run-time system written in Java.

JSDoc's syntax and semantics are similar to those of the Javadoc scheme, which is used for documenting code written in Java. JSDoc differs from Javadoc, in that it is specialized to handle JavaScript's dynamic behaviour.

Maps JSDoc

JSDoc tags

Some of the more popular annotation tags used in modern JSDoc are:

src: apprize.info

Example

src: raw.githubusercontent.com

JSDoc in use

• Google's Closure Linter and Closure Compiler. The latter extracts the type information to optimize its output JavaScript.
• Popular editor Sublime Text supports JSDoc through the DocBlockr or DoxyDoxygen plugin
• The JSDoc syntax has been described at length in the Apress book Foundations of Ajax ISBN 1-59059-582-3.
• IntelliJ IDEA, NetBeans and RubyMine understand JSDoc syntax.
• The Eclipse IDE has extensions that understand the JSDoc syntax. Eclipse-based Aptana Studio supports ScriptDoc, and the included JavaScript files are commented in ScriptDoc.
• Mozile, the Mozilla Inline Editor uses JSDoc.
• The Helma application framework uses JSDoc.
• SproutCore documentation was generated using JSDoc. [1]
• Visual Studio, WebStorm and many other Integrated development environments or Text Editors offer Code Completion and other assistance based on JSDoc comments.
• Open source Atom editor supports JSDoc via the atom-easy-jsdoc plugin.

src: i.ytimg.com

See also

• Comparison of documentation generators
• Google Closure Tools

src: raw.githubusercontent.com

References

src: i.ytimg.com

External links

• Official JSDoc Website, for tutorials and docs on usage
• Official JSDoc Github, for up-to-date code
• "Annotating JavaScript for the Closure Compiler", Closure Tools documentation, Google Developer website

Source of the article : Wikipedia