我正在寻找为JavaScript项目生成API文档。 JavaScript有没有类似于Python的文档字符串?向JavaScript函数添加文档的标准方式是什么?
function add(a, b) {
/**
Returns the sum of `a` and `b`.
*/
return (a - 0) + (b - 0);
}
我正在寻找为JavaScript项目生成API文档。 JavaScript有没有类似于Python的文档字符串?向JavaScript函数添加文档的标准方式是什么?
function add(a, b) {
/**
Returns the sum of `a` and `b`.
*/
return (a - 0) + (b - 0);
}
当我需要它,JSDoc是唯一可用的工具,并且是相当混乱。我们总是得到堆栈溢出,因为他们使用perl和正则表达式来解析源代码。乍一看JSDoc Toolkit如上所述看起来不错,他们现在使用JavaScript。
相关:http://stackoverflow.com/questions/1800853/is-there-any-similar-javadocs-script-tool-for-javascript-files – CMS 2010-11-15 00:53:37
谢谢@CMS - 看起来像我没有足够努力搜索 – 2010-11-15 01:38:57