What is the standard way of adding documentation to a JavaScript function?

Question

I'm looking at generating API docs for a JavaScript project. Does JavaScript have anything similar to Python's docstring?

function add(a, b) {
  /**
    Returns the sum of `a` and `b`.
  */
  return (a - 0) + (b - 0);
}

Answer 1

JSDoc is one way to do it.

/**
 * Adds two numbers.
 */
function add(a, b) {
    return a+b;
}

Answer 2

Have you seen JSDoc (which has now been superceded by JSDoc toolkit)?

Answer 3

When I needed it, JSDoc was the only available tool, and was pretty messy. We always got stack overflows because they used perl and regular expressions to parse the source. At first glance JSDoc Toolkit as mentioned look good, they're now using JavaScript.

Answer 4

PDoc is an in-line documentation generator for the Prototype library, written in Ruby.