| Latest Release Version: | 3.6.3 |
| Genre: | Programming documentation Format |
| Contained By: | JavaScript source files |
| Extended From: | JavaDoc |
| Open: | Yes |
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. The JSDoc specification is released under CC BY-SA 3.0, while its companion documentation generator and parser library is free software under the Apache License 2.0.
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.
An early example 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. It included a toy "JSDoc" HTML generator, versioned up to 1.3, as an example of its JavaScript capabilities.[1]
All main generations of "JSDoc" were headed by micmath (Michael Mathews). He started with JSDoc.pm in 2001, a simple system written in Perl. Later, with contributions by Canadian programmer Gabriel Reid. It was hosted on SourceForge in a CVS repository.[2] By JSDoc 1.0 (2007) he rewrote the system in JavaScript (again for Rhino), and after a set of expansions JSDoc 2.0 (2008) gained the name "jsdoc-toolkit". Released under the MIT License, it was hosted in a Subversion repository on Google Code.[3] By 2011 he has refactored the system into JSDoc 3.0 and hosted the result on GitHub. It now runs on Node.js.[4]
Some of the more popular annotation tags used in modern JSDoc are:
| Tag | Description | |
|---|---|---|
@author | Developer's name | |
@constructor | Marks a function as a constructor | |
@deprecated | Marks a method as deprecated | |
@exception | Synonym for @throws | |
@exports | Identifies a member that is exported by the module | |
@param | Documents a method parameter; a datatype indicator can be added between curly braces | |
@private | Signifies that a member is private | |
@returns | Documents a return value | |
@return | Synonym for @returns | |
@see | Documents an association to another object | |
@todo | Documents something that is missing/open | |
@this | Specifies the type of the object to which the keyword <var>this</var> refers within a function. | |
@throws | Documents an exception thrown by a method | |
@version | Provides the version number of a library |
/** * Prints a circle. * * @param circle */function printCircle(circle)
Note that the and tags can in fact be omitted: the ECMASyntax is sufficient to make their identities clear, and JSDoc makes use of that.[5] can be automatically deduced as well.[6]