Javascript文档生成

Question

我正在寻找我们开发的javascript代码的文档，并且正在寻找一些好的javascript文档生成器，有人有什么建议吗？

我们曾经使用ndoc为我们的c#代码创建文档，并且正在寻找类似于文档我们的js代码的东西-理想的是可以从命令行运行的东西。

提前感谢！

Answer 1

为此，您可以使用著名的JSDoc-Toolkit。

JsDoc工具包是一个用JavaScript编写的应用程序，用于从注释的JavaScript源代码自动生成模板格式的多页JsDoc(或XML、JSON或任何其他基于文本的)文档。

是的，它也有command line options。

Answer 2

JSDoc是一种从注释的JavaScript生成文档的方法。有许多变体：

• 它最初是用Perl.
• JSDoc-Toolkit实现的，它把它移植到了JavaScript上，但由于它使用了用Java编写的Rhino JavaScript引擎，所以需要Java。
• 一些人已经移植了它，以便直接在node.js JavaScript引擎/平台上运行，例如，它也运行在node.js上，它结合了类似JSDoc的标记和标记，但需要一个单独的模板引擎(就像在Stack Overflow和github上使用的那样)。

所有这些都从命令行运行。根据您的工具首选项进行选择。我喜欢node.js的速度和所有时间的感觉。JSON“让我们构建一个框架”post on writing documentation描述了这些工具和其他工具；不幸的是，由于它的编写，dox被彻底修改为只输出DailyJS结构。

https://stackoverflow.com/q/1221413/1162195提到了其他JavaScript文档生成器。