Xxx.GenerteCHM -＞ C#根据注释生成CHM帮助文档

最新推荐文章于 2023-06-21 17:50:45 发布
最新推荐文章于 2023-06-21 17:50:45 发布
阅读量262 收藏 1
点赞数
分类专栏： Xxx
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/CsethCRM/article/details/119731627
版权
本文指导如何下载并安装SHFB（SandcastleHelpFileBuilder），然后在VisualStudio2019中创建一个NET5.0测试项目，通过SHFB生成程序集的CHM帮助文件。详细步骤包括SHFB的安装，XML文件的生成，以及最终CHM文件的查看。附有资源包下载链接。
摘要由CSDN通过智能技术生成

一、下载SHFB（Sandcastle Help File Builde）

下载程序包地址：https://github.com/EWSoftware/SHFB/releases

在这里插入图片描述
在这里插入图片描述

二、安装 SHFB Installer

Next

在这里插入图片描述

Next

在这里插入图片描述

Next

在这里插入图片描述

下载并安装 THML Help

在这里插入图片描述

htmlhelp.exe 安装

在这里插入图片描述

确认接受

在这里插入图片描述

确认安装

在这里插入图片描述

确认安装目录

在这里插入图片描述

确认创建文件夹

在这里插入图片描述

确认更新

在这里插入图片描述

安装完成

在这里插入图片描述

回到 Sandcastle Guided Installation 步骤

Search Again

在这里插入图片描述

Next

在这里插入图片描述

Install SHFB

在这里插入图片描述

Next

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

Install Package (SHFB Visual Studio Package)

在这里插入图片描述
本人目前用的 Visual Studio 2019
在这里插入图片描述
在这里插入图片描述

Next

在这里插入图片描述

Install Schemas

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

Install Snippets

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

恭喜 SHFB 安装成功 _

三、新建一个Web（NET5.0）测试项目

新建项目

在这里插入图片描述

生成XML文件

在这里插入图片描述

四、利用VS2019生成CHM

新建项目

在这里插入图片描述

选择要生成CHM的XML

在这里插入图片描述在这里插入图片描述

生成CHM文件

在这里插入图片描述

在输出可以找到CHM的文件

在这里插入图片描述

打开查看CHM

在这里插入图片描述

恭喜，把NET 程序集注释生成CHM已完成。O(∩_∩)O~

文章所用资源包下载地址：
https://download.csdn.net/download/CsethCRM/21108743

安得权
关注
专栏目录
No .egg-info directory found in xxx\pip-pip-egg-info-mq
猿小白的博客
07-18 7552
No .egg-info directory found in xxx\pip-pip-egg-info-mq
qlafc-linux-8.01.04-3-install；qla2xxx-src-v8.08.00.07.07.0-k.tar
09-07
使用预centos或redhat安装HBA卡驱动，操作系统版本尽可能在centos6以及以前。安装操作步骤见：https://blog.51cto.com/chier11/5659237 有问题可以相互交流。谢谢
C#如何生成CHM帮助文件
02-24
这是一篇关于C#如何生成CHM帮助文件 希望能帮助大家解决问题
C#生成CHM文件（汇总篇）
weixin_34413103的博客
12-26 181
本文是前面的C#生成CHM文件系列文章的汇总以及一些其他的关于CHM的资料链接等。   C#生成CHM文件（入门篇） http://www.cnblogs.com/alexis/archive/2010/09/29/1837909.html C#生成CHM文件（中级篇） http://www.cnblogs.com/alexis/archive/2010/09/30/1839032.h...
C#生成CHM文件（应用篇）
weixin_34007020的博客
10-16 155
在入门篇中我们了解到如何使用C#调用hhc.exe来生成CHM文件，而在中篇中，我们进行了CHM反编译和将CHM文件转化为Word。在下篇中，我将简单介绍下这些技术在如何应用在实际项目中。 CHM电子书的优点： 1、CHM最好的地方就是对网页、图片的支持--实际上该格式类似于一个简版的IE浏览器，有目录、索引。 2、CHM的全文检索最为方便的是结果的高亮显示。 同时，CHM格...
C# 生成chm代码文档
C#开发
08-19 1678
如何生成chm代码文档？ 一、下载Sandcastle https://github.com/EWSoftware/SHFB/releases 通过上面的链接可以时刻下载到最新的版本。本文是针对vs2019来操作。 二、安装Sandcastle 下载解压后，会有一个SandcastleInstaller.exe文件，双击安装它。 如上图，安装过程会有很多个Next，一路点下去，若遇到有提示你要Install的地方，通通点一下安装即可，一直到最后一个Next点完，即表示安装完成。.
C#生成CHM帮助文件源码
08-30
C#生成CHM帮助文件源码
配置.gitlab-ci.yml - 自定义流水线
Tri_C的博客
12-26 4517
参考官网： gitlab持续集成流水线配置 结合官网，以一种探索性的方式，展示gitlab持续集成流水线的搭建过程。 gitlab持续集成流水线 - 无中生有 如果您对“持续集成”“流水线”概念还处于模糊阶段，那么这节也许很适合您。 持续集成 gitlab持续集成流水线 - 加入自己的东西 gitlab持续集成流水线 - 重构，更简练更强复用性 ...
ERROR: Could not build wheels for XXX, which is required to install pyproject.toml-based projects
热门推荐
longe20111104的博客
06-21 6万+
解决方法：ERROR: Could not build wheels for XXX, which is required to install pyproject.toml-based projects
SpringBoot 配置 datasource.driver-class-name 属性区分大小写
weixin_41800431的博客
02-12 3万+
 本人在维护一个Springboot项目时，修改配置文件之后，启动项目发现项目启动失败，报错信息： java.sql.SQLException: oracle.jdbc.driver.oracledriver at com.alibaba.druid.util.JdbcUtils.createDriver(JdbcUtils.java:570) ~[druid-1.0.29.jar:1.0....
SHFBInstaller_v2020.3.6.0.zip
06-17
SHFB（Sandcastle Help File Builder）MSDN风格的代码文档生成工具,支持Visual Studio 中将代码注释转换为文档
SHFBGuidedInstaller_2015.01.12.0
08-02
生成项目、dll文件中所有方法及参数的文档生成，包括 chm、docx、html、mshc、HxS
SHFB:沙堡帮助文件生成器（SHFB）。 独立的GUI，Visual Studio集成包和MSBuild任务提供了完整的配置和可扩展性，以使用Sandcastle工具构建帮助文件
04-28
欢迎使用Sandcastle帮助文件生成器项目。 该项目由两个相互配合的独立部分组成：Sandcastle工具和Sandcastle帮助文件生成器。 Sandcastle工具用于为包含概念和API参考主题的托管类库创建帮助文件。 通过将源代码中嵌入的XML注释与类型的语法和结构相结合来创建API参考主题，该语法和类型的结构是通过对相关的.NET Framework程序集进行反射而获得的。 通过转换您编写的包含Microsoft协助标记语言（MAML）的XML文档来创建概念性主题。 Sandcastle工具基于命令行，没有GUI前端，项目管理功能或自动构建过程。 Sandcastle帮助文件生成器的创建是为了填补空白，提供缺少的最常用的类似于NDoc的功能，并提供独立的GUI和基于命令行的工具以自动方式构建帮助文件。 还可以使用Visual Studio集成包，以便可以完全在Visual
SHFBGuidedInstaller C#帮助文档生成
03-25
SHFBGuidedInstaller C#帮助文档生成
vs注释生成chm帮助文档工具和详细说明书
06-21
vs注释生成chm帮助文档工具和详细说明书，即使你没有使用过vss也可以看懂。
解决nohup java -jar xxx.jar报出[1]+ Exit 1的错误：Unable to access jarfile xxx.jar和PersistenceException异常
念兮为美
08-25 6843
今天把manager.jar部署到测试环境的project目录下，使用如是指令启动项目：nohup java -jar manager.jar > log.file 2>&1 &启动项目，但报出[1]+ Exit 1 问题。由此排查问题原因，由Unable to access jarfile manager.jar和org.apache.ibatis.exceptions.PersistenceException引起的。...
C#制作源代码的帮助文档 chm帮助文档 C#类库帮助文档生成
Gavin luo 我们共同努力
03-25 6795
我们自己会写一个核心类库，提供给他人使用，如果没有帮助文档，是无法告诉别人如何使用你的类库的，即便是你有很好的注释，用以下工具就可以生成 .chm的帮助文档了。 1、下载Sandcastle Help File Builder： http://download.csdn.net/detail/gavin_luo/7095741 2、下载sandcastle： http://down
自动生成帮助文件的 Sandcastle 安装及使用介绍
weixin_30696427的博客
07-13 200
Sandcastle下载地址： https://github.com/EWSoftware/SHFB/releases 我下载的是当时的最新版安装版 SHFBInstaller_v2018.7.8.0.zip 解压以后运行 SandcastleInstaller.exe 进行安装。 Sandcastle有两种运行模式： 1.在VS里新建项目 2.运行Sandcastle独立的GUI ...
SHFB-Sandcastle Help File Build vs文档生成工具安装及配置
胡杰的专栏
12-19 1万+
SHFB-Sandcastle Help File Build vs文档生成工具安装及配置 2.2 软件安装 2.2.1 安装包 SHFBGuidedInstaller_2014.5.31.0.zip 2.2.2 安装 点击SandcastleInstaller.exe 按提示安装即可 第3章 软件使用 3.1.1 前提要求 第一：把生成帮助的工程的属性做下修改，右键工程，属性，生
nohup java -jar xxx.jar --server.port=8081 > nohup.out 2>&1 & 啥意思
最新发布
10-27
java -jar xxx.jar表示运行一个名为xxx.jar的Java应用程序。--server.port=8081表示指定应用程序的端口号为8081。> nohup.out 2>&1 &表示将应用程序的输出重定向到nohup.out文件中，并将标准错误输出也重定向到nohup...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

安得权

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值