JSDoc

JSDoc is a documentation mechanism for JavaScript.

Use with Eclipse

When editing JavaScript with an Eclipse editor, we see an Outline view on the right of the editor.  This utilizes JSDoc tags to identify the names of the exposed functions as well as whether or not they are public or private.

Documenting with markdown

By default,  JSDoc uses HTML as the documentation language however we can switch this to use Markdown.

See:

• Using the Markdown plugin

Primary References

See also:

• JSDoc home page