JavaScript文档生成

我正在寻找记录我们开发的JavaScript代码，并正在寻找一些很好的JavaScript文档生成器，有没有人有任何建议？JavaScript文档生成

我们以前使用NDoc的创建我们的C＃代码文件，并寻找类似的记录我们的js代码的东西 - 最好的东西，可以在命令行中运行。

在此先感谢！

2012-02-13 Dave Lister

我会建议检查[这个问题]（http://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript）以及 – 2013-10-27 12:46:02

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

JsDoc工具包是一个应用程序，JavaScript编写，对于自动生成模板格式化，多页的HTML（或XML， JSON，或任何其他基于文本的）从评论的JavaScript 源代码文档。

是的，它也有command line options。

来源

2012-02-13 15:23:09 Sarfraz

伟大的东西，我会检查它出来了！ – 2012-02-13 19:48:16

@DaveLister：不客气 – Sarfraz 2012-02-13 19:51:19

JSDoc-Toolkit似乎不再维护。该网站指向'jsdoc' https://github.com/jsdoc3/jsdoc – luiges90 2013-07-27 13:32:59

JSDoc是从评论的JavaScript生成文档的一种方法。有许多变化：

它最初是在Perl中实现的。
JSDoc-Toolkit将其移植到JavaScript，但需要使用Java，因为它使用了用Java编写的Rhino JavaScript引擎。
有几个人已将其移植到直接在node.js JavaScript引擎/平台上运行，例如， node-jsdoc-toolkit。
dox也运行在node.js的，它结合JSDoc状标签和降价标记但需要单独的模板引擎（对堆栈溢出和github上所用）。

所有在命令行中运行。根据您的工具偏好进行选择。我喜欢node.js，因为它的速度和所有JavaScript全时段的感觉。 DailyJS“让我们制作一个框架”post on writing documentation描述了这些和其他工具;不幸的是，dox从根本上被彻底改造，直到输出JSON结构，因为这是写的。

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

来源

2012-04-22 23:22:19 skierpage

感谢链接@skierpage！ – 2012-04-25 08:53:25

JavaScript文档生成

回答

相关问题