哪個註釋文檔格式更適合JavaScript？

Question

對於生成HTML文檔的這種格式，JavaScript和處理器是否有任何註釋文檔格式？

目前我正在使用VSDoc xml註釋在開發時提供智能感知幫助，但據我所知，沒有這種註釋的文檔生成器。 所以或者我的問題聽起來像這樣：是否有任何實用工具將VSDoc評論從JavaScript文件轉換爲HTML？

Answer 1

你看過自動生成的文檔從JavaDoc或VSDoc或JSDoc或類似的東西。

它們都是醜陋的和不可讀的。

的解決方案是雙重的

• annotate your code with docco
• 讓您的API文檔手寫。

還有第三種選擇是徹底改變我們自動生成文檔的方式，如果可以的話請做。

Answer 2

我用Natural Docs爲幾個項目。這個語法對於閱讀內聯是很好的，但是由於它沒有JavaScript的「全面語言支持」，所以你必須對每個函數/常量/類/你想要記錄的內容做些清晰的說明。

Answer 3

有一個分析JavaScript文件，並將其輸出的XML格式NDoc的和沙堡使用的實用程序：AjaxDoc

你從相同的意見VS智能感知，並且可以輸出所需的任何格式的方式。