Sandcastle Help File Builder官网

2024-10-01

Sandcastle----强大的C#文档生成工具

最近客户索要产品的二次开发类库文档,由于开发过程中并没有考虑过此类文档,而且项目规范比较,持续时间比较长,经手人比较多,还真是麻烦,如果人工制作文档需要是一个比较大的工程.还好有这个文档生成工具,能够根据项目生成文档,而且格式看起来确实很专业. Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具.它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,Hel

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

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

使用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使用教程

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

文档生成工具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

SpringBoot使用JSP（官网Demo）

最开始接触java的时候,前端页面基本都是用jsp来写,最近公司项目要使用SpringBoot重构,查看SpringBoot文档,发现SpringBoot不建议使用JSP,因为jsp在使用内嵌servlet容器时会有一些限制虽然以后项目中也会将jsp替换成Template Engines,而且这都是前端的事情,其实与后端并无比较大的联系,但比较好奇Springboot中对jsp的使用,故根据官方文档进行了简单测试验证如果使用JSP,则需要将项目打包成war包,jar包不支持JSP. 打开JS

【Spark深入学习 -16】官网学习SparkSQL

----本节内容-------1.概览 1.1 Spark SQL 1.2 DatSets和DataFrame2.动手干活 2.1 契入点:SparkSession 2.2 创建DataFrames 2.3 非强类型结果集操作 2.4 程序化执行SQL查询 2.5 全局临时视图 2.6 创建DataSets 2.7 与RDD交互操作 2.8 聚集函数3.Sp

3.1 Broker Configs 官网剖析（博主推荐）

不多说,直接上干货! 一切来源于官网 http://kafka.apache.org/documentation/ 3.1 Broker Configs 3.1 broker配置 The essential configurations are the following: broker.id log.dirs zookeeper.connect 基本配置如下: broker.id log.dirs zookeeper.connect Topic-level configurations and

Solon 1.6.10 重要发布，现在有官网喽！

关于官网千呼万唤始出来: https://solon.noear.org .整了一个月多了,总体样子有了...还得不断接着整! 关于 Solon Solon 是一个轻量级应用开发框架.支持 Web.Data.Job.Remoting.Cloud 等任何开发场景.短小而精悍! 强调,克制 + 简洁 + 开放的原则力求,更小.更快.更自由的体验关于 Solon Cloud Solon Cloud 定义了一系列分布式开发的接口标准和配置规范,相当于DDD模式里的防腐层概念.是 Solon 的微服

Unity 官网教程 -- Multiplayer Networking

教程网址:https://unity3d.com/cn/learn/tutorials/topics/multiplayer-networking/introduction-simple-multiplayer-example?playlist=29690 1. 新建一个3D工程,在菜单 "File" - "Save Scenes" ,保存场景为 "Main".注意,保存的文件放在Assets目录下. 2.菜单"GameObject&

BootStrap的一个标准框架的内容解释——来源于bootstrap官网

<!DOCTYPE html><html lang="zh-cn"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"><!--bootStrap不支持ie 的编

总结Spring、Hibernate、Struts2官网下载jar文件

一直以来只知道搭SSH需要jar文件,作为学习的目的,最好的做法是自己亲自动手去官网下.不过官网都是英文,没耐心一般很难找到下载入口,更何况版本的变化也导致不同版本jar文件有些不一样,让新手很容易一头雾水,这里根据多番查找后的结果进行总结,一来记录下来以备日后自己查阅,二来分享给众多新手. 首先看Spring. spring目前的官网地址:http://www.springsource.org/ 研究很久发现,要下载jar文件,主页上的其他花哨的英文信息直接可以忽略,直接在首页鼠标滚轮拉到

tornado web高级开发项目之抽屉官网的页面登陆验证、form验证、点赞、评论、文章分页处理、发送邮箱验证码、登陆验证码、注册、发布文章、上传图片

本博文将一步步带领你实现抽屉官网的各种功能:包括登陆.注册.发送邮箱验证码.登陆验证码.页面登陆验证.发布文章.上传图片.form验证.点赞.评论.文章分页处理以及基于tornado的后端和ajax的前端数据处理. 转载请注明出处http://www.cnblogs.com/wanghzh/p/5806514.html 抽屉官网:http://dig.chouti.com/ 一.配置(settings) settings = { 'template_path': 'views', #模板文件路径

全球各大运营商黑莓ROM官网下载链接汇总

全球各大运营商黑莓ROM官网下载链接汇总: 先来关于8830的. 4.2.2.196的rom 8830EFS_PBr4.2.2_rel365_PL3.0.0.85_A4.2.2.196_Sprint_ 地址:http://u.115.com/file/f7758cec37# 8830EFS_PBr4.2.2_rel365_PL3.0.0.85_A4.2.2.196_Sprint_.exe 4.5.0.186的rom 8830AMEA_PBr4.5.0_rel311_PL3.4.0.59_A4

开源Inno Setup官网下载、安装、打包教程（官网安装向导中文语言包）

安装Inno Setup篇 1.搜索Inno Setup 2.下载Inno Setup 3.选择下载最新 innosetup-5.5.9-unicode.exe 版本(innosetup-5.5.9.exe同样支持中文安装向导) 4.安装Inno Setup:选择安装语言(没有中文选项) 5.安装Inno Setup:同意协议 6.安装Inno Setup:安装路径 7.安装Inno Setup:安装Preprocessor 8.安装Inno Setup:创建桌面快捷方式 9.安装Inno Se

Python自学笔记-生成器（来自廖雪峰的官网Python3）

感觉廖雪峰的官网http://www.liaoxuefeng.com/里面的教程不错,所以学习一下,把需要复习的摘抄一下. 以下内容主要为了自己复习用,详细内容请登录廖雪峰的官网查看. 生成器通过列表生成式,我们可以直接创建一个列表.但是,受到内存限制,列表容量肯定是有限的.而且,创建一个包含100万个元素的列表,不仅占用很大的存储空间,如果我们仅仅需要访问前面几个元素,那后面绝大多数元素占用的空间都白白浪费了. 所以,如果列表元素可以按照某种算法推算出来,那我们是否可以在循环的过程中不断推算

Python自学笔记-字符串编码（来自廖雪峰的官网Python3）

感觉廖雪峰的官网http://www.liaoxuefeng.com/里面的教程不错,所以学习一下,把需要复习的摘抄一下. 以下内容主要为了自己复习用,详细内容请登录廖雪峰的官网查看. 1.理解变量在计算机内存中的表示也非常重要.当我们写: a = 'ABC' 时,Python解释器干了两件事情: 在内存中创建了一个'ABC'的字符串: 在内存中创建了一个名为a的变量,并把它指向'ABC'. 2.常量所谓常量就是不能变的变量,比如常用的数学常数π就是一个常量.在Python中,通常用全部大

Sandcastle Help File Builder官网

热门专题