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

使用SHFB(Sandcastle Help File Builder)建立MSDN风格的代码文档下载地址:http://sandcastle.codeplex.com/ 下载地址2:http://shfb.codeplex.com/downloads/get/1408995 根据这两种图就下一步下一步的安装.安装之后会在你的开始菜单里看到"Sandcastle Help File Builder"这个文件夹如下: 第二:我们来简单的建一个项目,写一个方法. public class…

Sandcastle Help File Builder 生成NET帮助文档

Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcastle Sandcastle生成的输出结果具有以下特点: Ø 类似于MSDN布局的界面. Ø 自动生成索引项.内容项目表.主题块和页面布局,提高一致性和熟悉程度. Ø 自动生成语法宣称部分. Ø 自动生成继承表. Ø 代码彩色化. Ø 提供多…

使用 Sandcastle Help File Builder 制作文档

1.下载安装 Sandcastle 程序. http://download-codeplex.sec.s-msft.com/Download/Release?ProjectName=shfb&DownloadId=1408995&FileTime=130655702941330000&Build=21029 2.在程序中使用批注将代码注释说明清楚. 标记说明 <event> 对某个成员可能引发的事件的说明. <example> “示例”,帮助类库使用者理解…

Sandcastle Help File Builder使用教程

Sandcastle Help File Builder相信很多的园友用过,小弟我最近因为工作原因需要生成公司的一套SDK的帮助文档,因此找了一些资料,发现网上的资料很多,但是都不怎么完全,有些只是随便写了一些类,生成一个帮助文档.没有整体性,因此在这里将我的一些步骤贴出来,供大家讨论.Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目,Sandcastle 本身是一个console…

Sandcastle Help File Builder（.NET帮助文档工具）的版本选择心得——支持VS2010至VS2015，高版本项目文件问题

作者: zyl910 一.缘由 "Sandcastle Help File Builder"(简称SHFB)是一个很好用.NET 帮助文档生成工具. 但它的每个版本支持的VS版本范围有限,且官网没有明确说明它与VS版本的区别.导致经常出现"明明装了SHFB,但VS打开不了它的项目"问题. 这时只有逐个版本安装尝试了.而GitHub下载速度慢,导致要花很久时间才能找到合适的版本.于是我做了一次完整的实验,有了一些心得. 二.心得 2.1 尝试安装2个版本最初曾经试过…

文档生成工具Sandcastle Help File Builder

Sandcastle Help File Builder http://shfb.codeplex.com/…

Use Sandcastle Help File Builder to generate help document

http://shfb.codeplex.com/ Note: If the the help file contains the text "[Missing <param> documentation for "step"]" It's usually either that you aren't generating XML comments or they are out of date. Look in the XML comments fi…

如何制作dll库的API文档，自动生成微软风格的chm文件 Sandcastle Help File Builder 使用方法

当你开发了一个库的时候,就需要给库开发一个api文档,微软提供了一个C#库的自动生成工具.我在使用的过程中记录了相关的信息,以供大家学习和查阅,如有不正之处,欢迎指出. 首先先下载一个软件,下载地址在github上:https://github.com/EWSoftware/SHFB/releases 下载最新的版本即可.到本地后开始安装先安装上面的msi文件,安装好以后,点击下面的文件现在还是打开不了的,还需要下载个东西这里有个提示很重要:意思是如果想使用单独的GUI程序,需要安装Mic…

ahjesus 创建msdn一样的帮助文档

转载自http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html 使用SandCastle创建.Net帮助文档 Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目Sandcastle 本身是一个console的程序,为了方便使用,我们可以使用他的GUI版本:Sandcastle Help File Builder…

无法安装 VMware Tools。尝试访问安装 VMware Tools 所需的图像文件“/usr/lib/vmware/isoimages/linuxPreGlibc25.iso”时出错: 2 (No such file or directory)。请参考产品文档或知识库文章 2129825，了解关于如何获取该客户机操作系统的 VMware Tools 软件包的详细信息。

无法安装 VMware Tools.尝试访问安装 VMware Tools 所需的图像文件"/usr/lib/vmware/isoimages/linuxPreGlibc25.iso"时出错: 2 (No such file or directory).请参考产品文档或知识库文章 2129825,了解关于如何获取该客户机操作系统的 VMware Tools 软件包的详细信息. 环境:vCenter 6.7,ESXI 6.7,RHEL7.5. 导入ovf包出现的莫名其妙的问题,全网都查不…

MSDN 单机 MVC 帮助文档

因为微软的mvc框架也是从开源框架演变而来的,所以微软没把mvc帮助文档放到单击帮助文档中.sososos下载好msdn单机帮助后,却找不到 System.Web.MVC 等命名空间的东西. 解决办法,下载软件 Offline Explorer,并进行相关设置就可以在本地查看mvc的类,方法. 下载连接:点击下载这是下载后的界面,网址可以看出是本地的,唯一不好的是本地无法索引,也无法搜索新建个项目,然后右击此项目的属性,在地址处填上msdn在线的mvc空间url,设置级别控…

通过visual studio制作类库的文档

java的集成开发工具,可以导出jar的文档. visual studio 也可以生成类库的文档,邮件项目属性,生成,输出下,选择XML文档文件.然后生成项目,就会再bin下面生成一个xml文件. 将xml生成chm文件. 参考文章标题:自动生成代码的chm格式帮助文档参考文章地址:https://blog.csdn.net/sanqima/article/details/44653293 内容摘抄: 在Visual Studio下编程,有两个很方便的生成chm帮助文档的工具.它们就是Sand…

Sandcastle帮助文档生成器使用介绍

一.软件介绍 Sandcastle是一个管理类库的文档编译器,是用于编译发布组件(Assembly)信息的一个工具,这个工具通过反射和Xslt技术,可以从dll文件及其xml注释(命令行编译时加/doc参数或vs2005设置项目属性得到)得到一个完整的帮助文档,格式可以是Html或CHM甚至是任何自定义的格式. Sandcastle与.NET Framework 2.0和.NET Compact Framework组合使用.Sandcastle支持本地化,并提供一个基本的命令行编译器…

Sandcastle生成帮助文档

http://www.cnblogs.com/net515/p/3311584.html Sandcastle帮助文档生成器使用介绍一.软件介绍 Sandcastle是一个管理类库的文档编译器,是用于编译发布组件(Assembly)信息的一个工具,这个工具通过反射和 Xslt技术,可以从dll文件及其xml注释(命令行编译时加/doc参数或vs2005设置项目属性得到)得到一个完整的帮助文档,格式可以是 Html或CHM甚至是任何自定义的格式. Sandcastle与.NET Fr…

23个.NET开源项目

Castle是.NET里走过了三年的开源框架,下载地址如:http://www.castleproject.org/index.html ,当然如果你是从事过JAVA开发并用过spring,hibernate的话,那看这个框架应该说是很清晰.另付上在这个框架上有研究的一些Blog文章:http://terrylee.cnblogs.com/,,看过他整理制作的新版本C#设计模式的人大概知道. Nbear 是另一个.NET开源框架http://nbear.org/ or http://www.co…

Sandcastle入门：创建C#帮助文档

Sandcastle入门:创建C#帮助文档今天学到了一个东西:利用vs2005生成的dll/xml来生成帮助文档. 完成这个伟大任务的是Sandcastle,微软推出的类库文档编译工具. 在开始这篇笔记之前,我想先感谢我文后提及的七篇关于Sandcastle的文章.是它们出色的阐述使得我能够整理出这篇笔记,之前我从未接触过.对于那七篇文章,我努力寻找它们的源出处链接,然而网络的传播性使得这些一再被转载的文章逐渐模糊了它们的来源,有一些是我无法确定的.因此,我希望,如果这篇文章有幸能被您转载,请…

使用Sandcastle工具为.NET项目工程生成一份项目帮助文档chm

Sandcastle的,由Microsoft创建的,是从创建MSDN风格的文档中使用的工具.NET程序集和关联的XML注释文件.目前的版本是2010年6月发布.这是命令行并没有GUI前端,项目管理功能,或像,你可以找到在NDoc的自动生成过程. Sandcastle的帮助文件生成器,填补空白,提供失踪NDoc的样是最常用的的功能,并提供基于图形和命令行的工具,以建立一个自动化的方式帮助文件. 必备软件:HtmlHelpWorkshop.exe 网上到处都有:如果本机已经安装就无需理会: 下面介绍…

百度地图和高德地图坐标系的互相转换四种Sandcastle方法生成c#.net帮助类帮助文档文档API生成神器SandCastle使用心得 ASP.NET Core

百度地图和高德地图坐标系的互相转换 GPS.谷歌.百度.高德坐标相互转换一.在进行地图开发过程中,我们一般能接触到以下三种类型的地图坐标系: 1.WGS-84原始坐标系,一般用国际GPS纪录仪记录下来的经纬度,通过GPS定位拿到的原始经纬度,Google和高德地图定位的的经纬度(国外)都是基于WGS-84坐标系的:但是在国内是不允许直接用WGS84坐标系标注的,必须经过加密后才能使用: 2.GCJ-02坐标系,又名“火星坐标系”,是我国国测局独创的坐标体系,由WGS-84加密而成,在国内,…

生成chm文档工具- Sandcastle -摘自网络

Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具.它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为我们提供完美的.NET类库文…

四种Sandcastle方法生成c#.net帮助类帮助文档

方法一前端时间在网上收集和自己平时工作总结整理了<干货,比较全面的c#.net公共帮助类>,整理完成上传github之后我又想,既然是帮助类,总得有个帮助文档于是乎想到了Sandcastle,Sandcastle貌似是微软官方目前唯一一个生成帮助文档这发面的工具.它可以配合Microsoft Visual Studio生成的dlll和xml注释文件生成完整的帮助文档.结合可视化工具Sandcastle Help File Builder,简单直接,还能生成各种属性的说明.支持Helpe1x:…

Sandcastle方法生成c#.net帮助类帮助文档chm

Sandcastle方法生成c#.net帮助类帮助文档即chm后缀的文档,其实是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档, 步骤1生成XML文档 1.打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加一个Student类,即学生信息,如下: using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.T…

使用Sandcastle 基于代码注释生成接口文档

一. 工具下载: 1. Sandcastle:Sandcastle是微软官方的文档生成工具,下载地址:http://www.codeplex.com/Sandcastle 2. SHFBGuidedInstaller:Sandcastle结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单.下载地址:http://shfb.codeplex.com/ 分别安装以上两个工具后,打开 Sandcastle Help File Builder GUI…

使用SandCastle创建.Net帮助文档

使用SandCastle创建.Net帮助文档引用自:http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可以去这里下载:Sandcatle 项目Sandcastle 本身是一个console的程序,为了方便使用,我们可以使用他的GUI版本:Sandcastle Help File Builde…

Sandcastle是什么

如果你的项目是.net开发,同时需要生成HTML的方法成员文档时,哪么就不得不拿出Sandcastle 因为Sandcastle是微软开发,并开源的文档生成工具; 这种生成进度等待的感觉很爽! 在这里下载 http://sandcastle.codeplex.com/ 安装包里如下…

使用 Sandcastle 生成代码帮助文档

使用 Sandcastle可以生成MSDN风格的帮助文档,生成的帮助文档既可以是chm文档,也可以是MS Help 2.x帮助文档. 1 下载并安装Sandcastle Sandcastle下载地址为:http://sandcastle.codeplex.com/ 2 下载并安装HTML Help Workshop HTML Help Workshop可以用来生成chm文件,有的系统可能已经安装了HTML Help Workshop,HTML Help Workshop的默认安装路径为C:\Pr…