8

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);
}
Improve this question
2

4 Answers 4

Reset to default
3

JSDoc is one way to do it.

/**
 * Adds two numbers.
 */
function add(a, b) {
    return a+b;
}
Improve this answer
Sign up to request clarification or add additional context in comments.

1 Comment

The + operator is not exclusively used for the arithmetic addition operation.
1

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

Improve this answer

Comments

0

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.

Improve this answer

Comments

0

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

Improve this answer

Comments

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.