Comparison of Java Script Document Generators

Comparison of Java Script Document Generators

One of your least desirable and least rewarding tasks as a software developer is creating documentation. Whether it’s for code you’re creating, a change you’re contemplating, or a problem that you’re trying to resolve, the actual task of documentation is often dull and unimaginative. Yet detailed, accurate, up-to-date documentation is of enormous value.

  • It helps insure that changes made to the source code don’t create unforeseen problems. It speeds and focuses software peer review efforts.
  • It lowers the likelihood of misunderstandings among developers and quality assurance teams.
  • It alleviates the need to spend time hand-holding new engineers as they get up to speed.

So as documenting is essential in software development, in JavaScript world following are some famous document generator tools for documenting APIs.

  • DoccoLogodoxxDOCCO
  • YUI
  • JSDoc
  • Doxxyui-logo-2xjsdoc_featured

Following table compares the above generator tools each other.

JSDoc

YUIDoc

Doxx

Docco

Syntax

Structured

Structured

Structured

Unstructured

Accessibility
(default theme)

Low

High

High

High

Search feature

Yes, not by default

Yes

No

No

Extra themes

Docstrap

One bundled. Others available.

No.

Bundled

Learning curve

Medium

Medium

Low

None

Source parsing

Yes

No

No

No

Customization

High

Medium

Low

Very low

Extensibility

High

Medium

Low

None

Speed

Medium

Low

N/A

Very High

A more detailed comparison can be found in here.

And a great discussion of the importance of good documentation can be found here.

Sample documentation pages of above tools for the same source are given in below. Take a look of the visual appeal of each. But in JSDoc we could customize it as we wanted.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s