The markup language JSDoc provides tags to describe common structures and tooling to hook into those tags, but Mozilla says all it ends up doing is providing an alphabetical list of projects.
“JSDoc scrambles up and flattens out your functions, leaving new users to infer their relationships and mentally sort them into comprehensible groups,” Erik Rose, senior staff software architect at Mozilla, wrote in a post.
Recommended by SmartArenaPost
But in a larger project, it is useful to intersperse prose with your API docs without having to copy and paste things,” according to sphnix-js’ website. “sphinx-js lets you use the industry-leading Sphinx documentation tool with JS projects.
It provides a handful of directives, patterned after the Python-centric autodoc ones, for pulling JSDoc-formatted documentation into reStructuredText pages.
And, because you can keep using JSDoc in your code, you remain compatible with the rest of your JS tooling, like Google’s Closure Compiler.”
More information on how to get started is available here.