sandcastle 使用说明,生成帮助api文件

安装前准备

1.工具下载sandcastle 地址http://sandcastle.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=13873
Sandcastle Help File Builder Installer (可视安装工具)
http://shfb.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=29710
2..NET Framework 3.5 SP1.
下载地址http://www.microsoft.com/downloads/details.aspx?FamilyID=ab99342f-5d1a-413d-8319-81da479ab0d7&DisplayLang=en
3.最新版Microsoft's Sandcastle 当前the May 2008 release as of January 3, 2010). 下载地址：http://sandcastle.codeplex.com
4.HTML Help Workshop 用于生成chm文件 http://msdn2.microsoft.com/en-us/library/ms669985.aspx
5.MS Help 2 (.HxS)文件编译需要Visual Studio 2005 SDK 或 the Visual Studio 2008 SDK.
2005sdk 下载地址 http://www.microsoft.com/downloads/details.aspx?familyid=51A5C65B-C020-4E08-8AC0-3EB9C06996F4&displaylang=en
2008sdk 下载地址http://www.microsoft.com/downloads/details.aspx?FamilyID=59ec6ec3-4273-48a3-ba25-dc925a45584d&DisplayLang=en
6.安装完毕，检查用户环境变量，如果出现DXROOT删除
环境变量中存在PATH变量，删除任何到Sandcastle SDK 的路径。
如（C:/Program Files/Microsoft Visual Studio 2008 SDK/VisualStudioIntegration/Tools/Sandcastle/ProductionTools）
检查系统环境变量确认存在DXROOT变量
生成
1.生成xml注释文件
右键项目 选择属性 选择（生成）Build 在（输出）Output 节，
选择 复选框(xml文档文件)Xml documentation file
通常xml文件名与程序集名称相同，程序集名称可在(应用程序)Application中查看
2.在程序集中xml注释类名方法名。///<summary>...形式
3.设置vs打开Help File Builder Project File
右击解决方案 添加现有项
生成xml帮助
1.打开Sandcastle中的File | New Project,Save As 保存一新项目，此时可看到项目浏览窗口与项目属性窗口.
2.右键Documentation Sources，选取要生成文档的dll如bin/test.dll
（如果已生成xml在同一目录下，自动加载）
3.编译Documentation | Build Project 此时会有消息窗口显示
警告与错误信息可以在帮中文档中的Errors and Warnings 中查看
此操作将大量消耗内存,内存小于1G将十分缓慢，当SdkLinkType被设置成MSDN时。在代理服务器下可能会创建失败。详情参考帮助中的Frequently Asked Questions
4.建成后，可选Documentation | View Help File菜单浏览帮助文件

date：              表示记录访问日期；
    time：              访问时间；
    s-sitename：  表示你的虚拟主机的代称。
    s-ip：               访问者IP；
    cs-method：   表示访问方法，常见的有两种，一是GET，就是平常我们打开一个URL访问的动作，二是POST，提交表单时的动作；
    cs-uri-stem：   就是访问哪一个文件；
    cs-uri-query： 是指访问地址的附带参数，如asp文件?后面的字符串id=12等等，如果没有参数则用-表示；
    s-port：             访问的端口
    cs-username： 访问者名称
    c-ip：                 来源ip
    cs(User-Agent)：访问来源；
    sc-status：状态，200表示成功，403表示没有权限，404表示打不到该页面，500表示程序有错；
    sc-substatus： 服务端传送到客户端的字节大小；
    cs–win32-statu： 客户端传送到服务端的字节大小；