Javascript文档生成

Question

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

我们曾经使用ndoc为我们的c#代码创建文档,并且正在寻找类似于记录我们的js代码的东西 - 理想情况下可以从命令行运行.

提前致谢!

Answer 1

您可以使用着名的JSDoc-Toolkit.

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

是的,它也有命令行选项.

Answer 2

JSDoc是一种从注释JavaScript生成文档的方法.有很多变化:

• 它最初是在Perl中实现的.
• JSDoc-Toolkit将它移植到JavaScript,但需要Java,因为它使用用Java编写的Rhino JavaScript引擎.
• 有几个人将它移植到node.js JavaScript引擎/平台上直接运行,例如node-jsdoc-toolkit.
• dox也运行在node.js上,它结合了类似JSDoc的标记和markdown标记,但需要一个单独的模板引擎(如Stack Overflow和github上所使用的).

全部从命令行运行.根据您的工具首选项进行选择.我喜欢node.js的速度和所有JavaScript-all-time时间的感觉.撰写文档的DailyJS"让我们制作一个框架" 帖子描述了这些和其他工具; 不幸的是,dox从根本上进行了大修,只是输出了JSON结构,因为它已被编写.

/sf/ask/85498941/提到了其他JavaScript文档生成器.