JSDoc

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

Noteworthy integration

• Google's Closure Linter and Closure Compiler. The latter extracts the type information to optimize its output JavaScript.
• TypeScript can perform type checking for JavaScript files with JSDoc type annotations.
• IntelliJ IDEA, NetBeans and RubyMine understand JSDoc syntax.
• 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.