博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档
阅读量:6378 次
发布时间:2019-06-23

本文共 895 字,大约阅读时间需要 2 分钟。

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

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

 

根据这两种图就下一步下一步的安装。安装之后会在你的开始菜单里看到“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:\Demo\Help

打开如下图:

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

转载于:https://www.cnblogs.com/licin/p/6092667.html

你可能感兴趣的文章
第8件事 3步打造产品的独特气质
查看>>
debug-stripped.ap_' specified for property 'resourceFile' does not exist
查看>>
利用MapReduce计算平均数
查看>>
scala-05-map映射
查看>>
Spring Boot - how to configure port
查看>>
右键添加复制路径选项
查看>>
DocFetcher 本机文件搜索工具
查看>>
ambassador 学习三 限速处理
查看>>
HTTP传输编码增加了传输量,只为解决这一个问题 | 实用 HTTP
查看>>
数据结构:最小生成树--Kruskal算法
查看>>
Swift_1_基本数据类型
查看>>
深入解析Vuex实战总结
查看>>
流水落花春去也
查看>>
【教训】为什么不作备份?!
查看>>
ThinkPHP3.0启动过程
查看>>
JAX-WS(JWS)发布WebService
查看>>
Centos7安装docker-compse踩过的坑
查看>>
细说Nullable<T>类型
查看>>
oracle 插入表数据的4种方式
查看>>
7.Ajax
查看>>