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


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

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

        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,文件新建一个项目,名字自己随意起,这里以Test为例。

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

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

    打开如下图:

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

  • 相关阅读:
    Ibatis,Spring整合(注解方式注入)
    Amoeba搞定mysql主从读写分离
    ClickjackFilterDeny X-Frame-Options
    Clickjacking: X-Frame-Options header missing
    升级至Struts2 2.5.2
    js和java MD5加密
    Struts2 2.5.2
    Struts2 2.5.2的套路
    java8 集合流式操作
    JS 文本输入框放大镜效果
  • 原文地址:https://www.cnblogs.com/luckly-hf/p/3300815.html
Copyright © 2020-2023  润新知