代码之家 › 专栏 › 技术社区 › Tim McNamara

向JavaScript函数添加文档的标准方法是什么?[关闭]

documentation-generation documentation javascript

6

Tim McNamara · 技术社区 · 15 年前

我正在考虑为JavaScript项目生成API文档。JavaScript有没有类似于Python的docstring?

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

4 回复 | 直到 15 年前

1

0

Russ Cam 15 年前

你见过吗 JSDoc (现在已经被 JSDoc toolkit )?

2

1

icktoofay pcp 15 年前

JSDoc 是一种方法。

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

3

0

neurolabs 15 年前

当我需要它时,JSDoc是唯一可用的工具,而且相当混乱。我们总是会遇到堆栈溢出,因为它们使用perl和正则表达式来解析源代码。乍一看 JSDoc Toolkit 如前所述,他们现在正在使用JavaScript。

4

0

Tim McNamara 15 年前

PDoc Prototype 库,用Ruby编写。