向JavaScript函数添加文档的标准方法是什么？

Question

我正在为JavaScript项目生成API文档。 JavaScript有什么类似于Python的docstring吗？

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

Answer 1

JSDoc是一种方法。

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

Answer 2

您是否见过 JSDoc （现已被 JSDoc toolkit 取代了？）

Answer 3

当我需要它时，JSDoc是唯一可用的工具，并且非常混乱。我们总是得到堆栈溢出，因为它们使用perl和正则表达式来解析源代码。乍一看JSDoc Toolkit如上所述看起来不错，他们现在正在使用JavaScript。

Answer 4

PDoc是Prototype库的内联文档生成器，用Ruby编写。