使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

下载地址:http://sandcastle.codeplex.com/

下载地址2:http://shfb.codeplex.com/downloads/get/1408995

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

根据这两种图就下一步下一步的安装。安装之后会在你的开始菜单里看到“Sandcastle Help File Builder”这个文件夹如下:

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

第二:我们来简单的建一个项目,写一个方法。

public class Class1
{
    /// <summary>
    /// 返回一个字符串
    /// </summary>
    /// <returns>字符串</returns>
    public string HelloWord()
    {
        return "欢迎来到 HelloWord 世界!";
    }
    /// <summary>
    /// 根据参数返回一个字符串
    /// </summary>
    /// <param name="str">参数</param>
    /// <returns>字符串</returns>
    /// <example>string str=HelloWord("aaaaaaaaaaa");</example>
    public string HelloWord(string str)
    {
        return str;
    }
 
}

之后设置其属性如下图:看到“输出”一栏,要在xml文档文件前打勾,路径使用默认即可。再回来生成一下项目。

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

第三:打开SHFB,文件新建一个项目,名字自己随意起,这里以Test为例。

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

在Test项目下Documentation Sources右键点击,选择 Add Documentation Sources.然后把上一步生成的*.xml文件添加进来如下图1,然后点击下图3,过一点时间会生成如图3.大功告成。

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

第四:找到刚才你保存创建的位置,我的是保存在F:\Demo\Help

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

打开如下图:

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档

OK,大功告成!这里只是一个简单的,大伙还可以在琢磨琢磨里面有更多的东东。互相学习交流一下。

上一篇:SpringCloud学习之Ribbon


下一篇:SeaJS之shim插件:解决非cmd规范的插件与sea的区别