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文檔生成

回答

相關問題