Sandcastle Help File Builder使用教程

【Sandcastle Help File Builder使用教程】的更多相关文章

Sandcastle Help File Builder使用教程

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

使用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帮助文档工具）的版本选择心得——支持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/…

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> “示例”,帮助类库使用者理解…

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…

DVWA File Upload 通关教程

File Upload,即文件上传.文件上传漏洞通常是由于对上传文件的类型.内容没有进行严格的过滤.检查,使得攻击者可以通过上传木马获取服务器的webshell权限,因此文件上传漏洞带来的危害常常是毁灭性的. 先看常规的文件上传操作: 客户端上传: <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <titl…

DVWA File Inclusion 通关教程

File Inclusion 介绍File Inclusion,即文件包含(漏洞),是指当服务器开启allow_url_include选项时,就可以通过php的某些特性函数:include(),require()和include_once(),require_once()等等,利用url去动态包含文件,此时如果没有对文件来源进行严格审查,就会导致任意文件读取或者任意命令执行. 文件包含分类: LFI:本地文件包含(Local File Inclusion) RFI:远程文件包含(Remote F…

AutoPlay Menu Builder入门教程

1 拖动窗口可以设置主界面的窗口大小,在下面有版面预览 2 常用东西介绍.右侧的素材库除了按钮还有图像,背景,音乐等.使用按钮的时候选中需要的按钮样式,双击即可上屏.图形按钮即使可以使用图像作为背景的按钮.所谓的炫目标签其实就是渐变文本.可以设置渐变的色彩,但是不如PS中灵活. 3 不管是按钮还是图形按钮都要注意一个子图数目,这个默认值是三,分别对应正常,鼠标经过,鼠标按下的时候的三种状态.如果比如下面的这个图形按钮.我们把一个地球的图片作为背景.则默认只会看到上面的三分之一. 在预览状态下(按…

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

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

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

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

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

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

使用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/ 安装包里如下…

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

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

Sandcastle生成帮助文档

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

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

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

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

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

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…

制作API离线chm帮助文件教程

当我们开发好一个通信库的时候,我们希望给这个通信库配备一个帮助文档,最好的方式,就是有一个离线的chm版本的API文档,这样别人在使用的时候,就可以清楚看到命名空间.类的结构,同时也能看到每个方法和属性的结构.刚好最近在制作xktComm通信库的API帮助文档,借此机会,跟大家介绍一下如何制作API文档.1.首先要将制作的dll写好注释,在类库项目属性中,勾选XML文档文件,这样就会生成该dll对应的说明文档xml文件. 2.然后需要下载一个软件SHFB,下载地址在github上:https:/…

为 C# 代码生成 API 文档（译）

原文地址:http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html#comments Sandcastle 功能概述如果您使用过的程序集中,带有详细的 API 说明文档,并且文档的格式和 MSDN 上的一样,您将发现这样 API 说明文档的是多么的方便.生成类似的 HTML 格式文档的方法有很多,不过,我发现其中最简单的方法是使用 Sandcastle 工具来生成这样的 API 文档.Sandcastle …

制作Net程序的帮助文档--总结

一.工具的准备目前,一般采用Sandcastle Help File Builder工具来制作.Net程序帮助文档,该工具主要是利用Xml文档里的信息以及DLL文件来生成完整的帮助文档.在Visual Studio中,使用三个/的注释内容才会被写入XML文档里,而两个/的注释是不会被写入的. 建议了解一下:XML注释标签讲解 1.GhostDoc--VS代码注释插件 VS本身提供了自动生成XML注释的快键方式,比如在成员函数上面敲入///,VS会自动一种注释框架,但是这种注释里是不包含关于成员…

为 C# 代码生成 API 文档（自译）

原文地址:http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html#comments Sandcastle 功能概述如果您使用过的程序集中,带有详细的 API 说明文档,并且文档的格式和 MSDN 上的一样,您将发现这样 API 说明文档的是多么的方便.生成类似的 HTML 格式文档的方法有很多,不过,我发现其中最简单的方法是使用 Sandcastle 工具来生成这样的 API 文档.Sandcastle …

DotNet 资源大全中文版（Awesome最新版）

Awesome系列的.Net资源整理.awesome-dotnet是由quozd发起和维护.内容包括:编译器.压缩.应用框架.应用模板.加密.数据库.反编译.IDE.日志.风格指南等. 算法与数据结构(Algorithms and Data structures) Algorithmia - Algorithm and data-structure library for .NET 3.5 and up. Algorithmia contains sophisticated algorithms…