【原创】Sandcastle生成MSDN的帮助文档

对于Sandcastle可能对于有些人毕竟陌生，其实看标题我已经写出这个技术是做什么的了，它就是生成帮助文档的。为什么要生成帮助文档呢? 当你开发一个类库，里面包含很多你自己重要的东西，想发布给其它人来使用，又不想公布源代码。别人在使用时很需要一个帮助文档。来了解你的类库内容。所以就出现了这个Sandcastle。

微软定义如下：

“MSDN Library for Visual Studio 2008 是权威的开发人员文档。我们将继续为您提供有关 Visual Studio 2008 发行版本地帮助的最新信息，同时，我们还增强了帮助选项，包括联机 F1 主题、搜索、索引以及联机或脱机使用目录的能力。有关本文档库改进功能的更多信息，请单击右侧的链接或访问新增功能页面。”

一、环境要求

（1）操作系统：ITPUB个人空间0b4vS,P"do"Q!K
Windows Server 2003; Windows XP Service Pack 2; Windows Vista;

(2)必备软件

Sandcastle.msi

(可以去官网下载http://download.codeplex.com，文件有点大，有需要的可以给我留邮箱)

二、开始使用。

（1）安装Sandcastle.msi文件

记住你的安装路径，在路径下面搜索找到SandcastleGui.exe文件(我默认的安装路径在C:\Program Files\Sandcastle\Examples\Generic下)，双击可以看到界面如下：

界面是不是很简单，我就把

（2）我们先建立一个库类MSDNSendcastle,以便生成帮助文档，再建立一个类UserInfo.cs,内容如下：

 /// <summary>
    /// 用户信息类
    /// </summary>
    public class UserInfo
    {
        private int userID;
        private string userName;
        private string userPwd;

        /// <summary>
        /// 用户ID
        /// </summary>
        public int UserID
        {
            get { return userID; }
            set { userID = value; }
        }
        /// <summary>
        /// 用户名
        /// </summary>
        public string UserName
        {
            get { return userName; }
            set { userName = value; }
        }
       /// <summary>
       /// 用户密码
       /// </summary>
        public string UserPwd
        {
            get { return userPwd; }
            set { userPwd = value; }
        }
        /// <summary>
        /// 登录验证
        /// </summary>
        /// <param name="UserName">用户名</param>
        /// <param name="UserPwd">密码</param>
        /// <returns>是否正确</returns>
        public bool VerificationUserPwd(string UserName, string UserPwd)
        {
            if (userName == "test" && userPwd == "123456")
            {
                return true;
            }
            return false;
        }

我们接下来在项目的属性窗口中生成选项下，选择一个XML文档文件,截图如下

点击确定后，再编译，是不是在Bin文件夹下找到了我们以上命名的MSDNSendcastle.XML文件。

（3）生成帮助文档

点击SandcastleGui.exe文件，设置如下

 点击完Build后就等待吧。成功后在安装目录下搜索你的MSDNSendcastle.chm(我的默认目录C:\Program Files\Sandcastle\Examples\MSDNSendcastle\vs2005\chm)

打开MSDNSendcastle.chm文件可以看到你的类库生成帮助文档了吧。

这是Sandcastle的最简单的操作，有兴趣的同学可以去网上找些其它资料来看。