如何從JavaScript生成msdn文檔？最好使用沙堡

Question

有沒有我可以用來生成MSDN類型文檔的工具？

我最近剛剛開始玩沙堡，我發現那裏曾經有一個名爲scriptdoc的工具，但它已被吸收到aptana中，我並不想使用aptana工作室。

我到目前爲止所能找到的是jsdoc，它是一個從javascript文件中提取評論的perl腳本，但我仍然在尋找更合適的方法。

從我的初步測試似乎從jsdoc生成的XML不匹配沙塔完成或也許我失去了一些東西有...

任何幫助嗎？

Answer 1

你必須使用vsdoc進行評論...語法就像c＃vsdoc一樣，但註釋會放在你正在記錄的函數中，而不是在之前。例如：

function foo(bar) { 
/// <summary>a function called foo</summary> 
/// <param name="bar"> a param called bar </param> 
/// <returns type="Boolean">Boolean value of bar </returns> 
return !!bar; 
} 

Answer 2

您可能想要檢查YUIDoc。這是我們在所有項目中使用的，最終輸出看起來像http://yuilibrary.com/yui/docs/api/classes/Anim.html。當然，外觀可以用你自己的模板，自定義的CSS等完全自定義，所以你可能會想出完全不同的東西