List Headline Image
Updated by Ashish Gupta on Mar 20, 2017
Headline for Auto-generate JavaScript reference documentation
 REPORT
Ashish Gupta Ashish Gupta
Owner
12 items   15 followers   4 votes   821 views

Auto-generate JavaScript reference documentation

Listing the various software available to create reference documentation from your JS source files.

Source: http://stackoverflow.com/questions/669698/what-options-are-available-for-documenting-your-javascript-code

jsdoc3/jsdoc

jsdoc - An API documentation generator for JavaScript. An updated version of the old JSDoc Toolkit.

YUIDoc - Javascript Documentation Tool

YUIDoc is a Node.js application that generates API documentation from comments in source, using a syntax similar to tools like Javadoc and Doxygen. Slightly more verbose and generates very neat outputs; syntax similar to tools like Javadoc and Doxygen; provides Live previews; “generated documentation is an attractive, functional web application with real URLs and graceful fallbacks for spiders and other agents”.

4

JSDuck

JSDuck

jsduck - Simple JavaScript Duckumentation generator. Infers info directly from the code. Big projects are already using it; Supports references to images and videos; Single exe file for setup on Windows with everything bundled.

SmartComments

JavaScript based, ad-hoc generation in the website via copy n paste weblet, in-line editing, customizable, HTML5, Sublime Text Plugin, custom parameters, node.js usable, npm, YUIDocs integration

3

Docco

Docco

Docco is a quick-and-dirty documentation generator, written in Literate CoffeeScript. It produces an HTML document that displays your comments intermingled with your code. All prose is passed through Markdown, and code is passed through Highlight.js syntax highlighting. This page is the result of running Docco against its own source file.

5

Natural Docs

Natural Docs

Natural Docs is an open-source documentation generator for multiple programming languages. You document your code in a natural syntax that reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it.

6

PDoc

PDoc

Unlike other inline-doc parsers, PDoc does not rely on the JavaScript source code at all; it only parses the comments. This approach, though slightly more verbose, is much better at generating consistent, reliable documentation, and avoids the headaches encountered when documenting highly dynamic languages.

Doxygen: Helper tools and scripts

Source code documentation and analysis tool. Jörg Schaible has written a perl script to let doxygen deal with JavaScript.

ext-doc - ExtJS-style JavaScript comments processor

ExtJS library has a specific javascript documentation style. ext-doc parses javascript source files and creates template-based output.

ROBODoc

ROBODoc is a documentation tool. It extracts the documentation from your source code and formats it in HTML, RTF, TeX, XML DocBook (PDF), or ASCII.

Ortelius - Javascript & AS documentation generator tool

The Ortelius - actionscript and javascript documentation generator, is a tool that ease the task of creating documentation. This actionscript and javascript documentation generator is an easy-to-use tool to generate html documentation of your actionscript or javascript code.

The Dojo Toolkit

In Dojo Inline Documentation we detailed the markup syntax and conventions available to document your API inline in your code. These inline docs can be extracted using the doctools parser - a php-based script available in util/docscripts in your svn checkout of the Dojo Toolkit.

  • Listly By

    Ashish Gupta

    PRO CURATOR

    Ashish has several years of experience working with content. He is a technical communicator and a community builder by profession; UX advocate and a quality champion by nature; and a Chemical engineer from IIT Bombay by academic qualification.

    In his spare time he likes to spoil his son silly, test workflows, identify usability enhancements and new features in software that he uses, and indulge in the online communities. Other interests areas in which Ashish dabbles are Instructional content, eLearning, social media, SEO, project management, life skills, watching soccer, fantasize about running long marathons some day, and occasionally trekking in the Himalayas.

  • Tagged With

  • Tools