Truly
写精彩代码 品暇逸人生
posts - 91,comments - 425,trackbacks - 55

作者: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://www.cnblogs.com/Files/Truly/MicrosoftAjaxDebugJS.rar,也可以到ASP.NET Ajax官方站点ajax.asp.net下载

posted on 2007-08-08 15:45  Truly  阅读(3316)  评论(2编辑  收藏