使用Sandcastle生成CHM帮助文档

最新推荐文章于 2020-07-29 13:48:46 发布
最新推荐文章于 2020-07-29 13:48:46 发布
阅读量76 收藏
点赞数
文章标签： python
原文链接：https://my.oschina.net/Yamazaki/blog/476707
版权

2019独角兽企业重金招聘Python工程师标准>>> hot3.png

大家或许都看过很多软件的帮助文档，好的帮助文档不但能够帮助用户使用软件，而且能够快速查询。

工欲善其事，必先利其器，今天我们亲自为自己的程序生成帮助文档。

这款小工具名为Sandcastle，是微软开源社区的项目，它可以生成MSDN风格的帮助文档。

生成的帮助文档如下示例：

chm-help-document

零度下载

转载于:https://my.oschina.net/Yamazaki/blog/476707

weixin_33875564
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
C# 代码 XML 注释规范及其 .chm 帮助文档生成
Devin的博客
03-06 2621
一.摘要 当我们进行程序开发时，面对一个大型项目，需要多人分工合作，每人实现一个模块。当我们需要调用他人编写的模块时，首先参考的不是源码部分，而是要去通读其代码注释部分。因此，代码注释是否规范标准，很大程度上影响着项目的开发进度。 .Net允许开发人员在源代码中插入XML注释，这在多人协作开发的时候显得特别有用。C#解析器可以把代码文件中的这些XML标记提取出来，并作进一步的处理为外部文档。在...
python_中文帮助文档2018新CHM
09-23
python 是一种全功能的语言，2.7很稳定，成熟的版本，且有很多开源的模块。这个是比较全面的一个python帮助文档，包含了python入门的内容以及标准库的介绍，全中文
Sandcastle(.net程序集CHM帮助文件生成器)
07-28
Sandcastle(.net程序集CHM帮助文件生成器)
使用 Sandcastle 生成 chm 帮助文档
matry的专栏
12-12 425
在上篇文章（编写并生成文档注释）中，我们已经了解了如何为类型和成员编写文档注释，以及如何生成相应的文档注释文件。在本文中，将简单地介绍如何使用 Sandcastle 生成 chm 文档。  Sandcastle 是一个文档生成工具，可以用它生成 MSDN 风格的文档，既能够生成 chm 文档，也能够生成 MS Help 2.x 帮助文档。在此之前曾流行的 NDoc，其作者已经放弃更新。  
用Sandcastle生成CHM1.x中文文档（续）
凤凰涅磐，做不老的程序员
12-25 206
前一篇文章《用Sandcastle生成CHM1.x中文文档》发布了之后，有些朋友希望获得我翻译的中文模版。 现共享如下： /Files/didasoft/Docs.zip 先说明一下，这些文件翻译的是VS2005风格的模版。 那么，如何使用这些文件呢？ 首先，我们需要在相应的目录下创建zh-CN子目录。这些目录包括： C:\Program Files\Sandcastle\Presen...
Sandcastle方法生成c#.net帮助类帮助文档chm
weixin_34055910的博客
07-30 171
Sandcastle方法生成c#.net帮助类帮助文档即chm后缀的文档，其实是通过C#文档注释生成的XML文件来生成帮助文档的。因此，第一步就是生成XML文档， 步骤1生成XML文档 1、打开VS->随意创建一个项目（这里我用的是控制台项目），然后添加一个Student类，即学生信息，如下：   using System;using System.Collections.Generic;...
Sandcastle生成帮助文档
金溪的博客
06-11 1546
生成帮助文件软件选择 如要想与VS集成在一起，可以使用 （1）Sandcastle Help File Builder  http://shfb.codeplex.com/ （2）DocProject   http://docproject.codeplex.com/ （3）GhostDoc   http://submain.com/products/ghostdoc.aspx 如果不用...
Sandcastle代码帮助文档生成器
12-09
CHM文档，全称是Compiled HTML Help，是一种常见的Windows平台上的离线帮助文件格式，将HTML页面集合打包成一个可执行文件，用户可以通过搜索和索引快速查找所需的信息。而MS Help 2.x则是微软早期开发的一种在线...
C#生成CHM帮助文件源码
11-13
在IT行业中，生成CHM（ Compiled Help Manual）帮助文件是一种常见的技术，主要用于创建电子版的文档和手册。这种格式能够方便用户快速查找和浏览信息，尤其适用于软件开发中提供API参考或用户指南。C#语言提供了...
SandcastleHelpFileBuilder2017有一个25页的使用说明文档
最新发布
04-19
注意：如果需要生成chm还需要微软的 MicrosoftHTMLHelpWorkshop 支持，Sandcastle生成时会自动去查找MicrosoftHTMLHelpWorkshop 的安装目录。 安装： 安装很简单，两个软件都只需要直接点击“下一步”即可安装完成...
用Sandcastle生成CHM1.x中文文档
凤凰涅磐，做不老的程序员
11-28 154
  用Sandcastle生成CHM1.x中文文档的过程： 需要下载的工具包括： Sandcastle - October 2007 Community Technology Preview (CTP)： http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&amp...
Sandcastle生成CHM帮助文档
FANET
01-05 966
NDoc是一个很好的工作，可以把.net中的注释导出，生成chm文档一边查阅和管理。可惜因为没有得到开源社区的支持已经停止开发，中国自学编程网，www.zxbc.cn 。   Sandcastle原本是微软内部用于开发管理的一个工具，它的功能和NDoc基本一致。由于它能够得到微软的支持，所以更新和维护基本不用担心。   但Sandcastle目前还不够完善，至少有两点不足
使用 Sandcastle 生成代码帮助文档
三五月儿的专栏
01-18 7684
使用 Sandcastle可以生成MSDN风格的帮助文档，生成的帮助文档既可以是chm文档，也可以是MS Help 2.x帮助文档。   1 下载并安装Sandcastle Sandcastle下载地址为：http://sandcastle.codeplex.com/   2 下载并安装HTML Help Workshop HTML Help Workshop可以用来生成chm文件，有
vs2019 使用 SHFB-Sandcastle Help File Build 文档生成工具 自动生成程序文档
Damon的博客
07-29 3506
网上别人传的都比较老了，请到GitHub下载最新版本：https://github.com/EWSoftware/SHFB/releases vs2019，安装好sandcastle后，如果直接使用GUI界面的，会有bug，报错“The tools version "15.0" is unrecognized.” 问题具体见：https://github.com/EWSoftware/SHFB/issues/790 原作者给出了答案： So, for now, if you have Visual.
自己动手将在线文档制作成CHM文件
热门推荐
lostaway的专栏
04-20 1万+
在线帮助文档转CHM方法 用到的工具：       wget工具(Linux自带，Windows下请自行下载)，htm2chm(共享软件，不过没什么限制) 具体步骤： 1、使用wget工具下载在线文档整个目录     简单介绍一下wget的几个用到的参数。
Javadoc转换chm帮助文档的四种方法总结
李顺利
01-06 8395
Googel 标签: Javadoc 转换 chm ;Javadoc ;chm ;转换 jd2chm ;javadoc2chm ;javadoc2help ;Javadoc2chm ;中文乱码 ;Java ;JavaEE ;李顺利 Javadoc转换chm帮助文档的四种方法总结                                                    
C#编程规范：文档注释与XML生成
“C#文档注释规范.doc 是一份关于C#编程中如何规范地使用文档注释的指导文件，旨在帮助程序员遵循一定的标准来编写源代码中的注释，以便工具能够自动生成XML文档，进一步用于生成类型信息和相关文档。这份文档属于C#...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值