使用SandCastle和ScriptDoc建立JavaScript文檔

來源:互聯網
上載者:User

作者:Truly
日期:2007.8.8

首先我們要遵循JavaScript注釋規範,詳見ScriptDoc和
    http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx

下面是SandCastle的一些相關網站    
http://blogs.msdn.com/sandcastle/
   
Sandcastle June CTP 的
http://www.microsoft.com/downloads/thankyou.aspx?familyId=e82ea71d-da89-42ee-a715-696e3a4873b2&displayLang=en

都下載安裝好,運行ScriptDoc則可以在Output目錄中找到產生的MicrosoftAjax.org和MicrosoftAjax.xml,注意codeplex上面的版本是對應1.0.0.0版本的Asp.net Ajax架構,而現在ms官方網站上面的版本是1.0.61025.0,所以可能部分代碼有點問題。假設你可以正確產生MicrosoftAjax.org和MicrosoftAjax.xml,如果不能正確產生的,請到ScriptDoc這裡下載,我們今天要使用的是MicrosoftAjax.org。

由於官方的SandCastle暫時還不能完美的支援ScriptDoc,這裡我簡單做了一個修正,但是產生的文檔跟我們的期望還是有點差距的,等我進一步完善後,再貼出補丁包。

暫時可以使用下面補丁進行預覽

我製作的補丁包Sandcastle.rar

執行說明:1.首先需要安裝好SandCastle,上面已經給出。

            2.然後將上面的補丁包覆蓋過去,運行Example中的runme.bat,等待片刻即可。

說明:我修改了SandCastle的一個SyntaxComponents組件,避免了錯誤判出,Exapmle\Truly\目錄中的MicrosoftAjax.org即是用ScriptDoc匯出的MicrosoftAjax.js檔案的注釋文檔。

小節:SandCastle組件大量使用反射,以及ASP.NET AJAX實現的反射機制,都值得我們深入研究。

資源:
http://blog.csdn.net/hustorochi/archive/2007/07/20/1700449.aspx 文中詳細講解了SandCastle和Sandcastle Help File Builder等的使用。
http://blogs.msdn.com/sandcastle/              SandCastle
http://www.codeplex.com/scriptdoc           ScriptDoc

這裡我把一個產生好的文檔放上來,先預覽一下,有待完善,需要重新製作模版
這裡是原始的MicrosoftAjax.js檔案:http://files.cnblogs.com/Truly/MicrosoftAjaxDebugJS.rar,也可以到ASP.NET Ajax官方網站ajax.asp.net下載

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.