SHFB生成CHM的Demo资源-CSDN下载

共133个文件

map：23个

css：21个

js：15个

194 浏览量 2024-03-14 16:47:12 上传评论收藏 951KB 7Z 举报

标题中的"SHFB生成CHM的Demo"指的是使用Sandcastle Help File Builder（SHFB）创建一个帮助文件（CHM）的示例项目。Sandcastle Help File Builder是一个开源工具，主要用于生成专业的.NET框架程序文档，包括HTML帮助文件（CHM）、XML文档注释以及在线帮助系统。CHM，即Compiled HTML Help，是Microsoft开发的一种帮助文件格式，通常用于Windows应用程序，它将HTML文件、图像和其他资源编译到单个可执行文件中，便于用户查看和搜索。在描述中提到的"SHFB生成CHM的Demo"，可能是一个包含示例代码、配置文件和构建脚本的项目，用于演示如何使用SHFB来创建CHM文件。通过这个示例，开发者可以学习如何组织源代码注释，如何配置SHFB项目，以及如何执行生成过程。 SHFB的关键知识点包括： 1. **源代码注释**：使用XML注释在C#、VB.NET或其他.NET语言的源代码中添加文档注释。这些注释遵循特定的模式，如`<summary>`, `<param>`, `<returns>`等，用于解释类、方法、属性等的功能。 2. **SHFB项目**：SHFB使用项目文件（.shfbproj）来管理文档生成设置，如输出格式、样式、布局等。项目文件可以配置为包含多个源代码项目，并定义如何处理它们。 3. **构建过程**：SHFB提供了命令行工具和Visual Studio扩展，允许开发者在IDE内或通过自动化脚本进行构建。构建过程包括解析源代码注释、生成文档结构、应用模板和样式，最后编译成CHM文件。 4. **模板和样式**：SHFB支持自定义模板和样式，以改变生成文档的外观和感觉。这可以通过修改或创建新的XSLT转换文件实现。 5. **插件支持**：SHFB允许添加插件来扩展其功能，例如，可以使用插件将文档发布到网站或生成PDF版本。 6. **CHM特性**：CHM文件有内置的索引、搜索和书签功能，提供了一种方便用户查找和浏览信息的方式。在SHFB中，这些特性可以被自定义和优化。 7. **调试和测试**：SHFB生成的CHM文件可以在本地进行预览和测试，以确保内容正确无误，链接有效，样式一致。通过"chmDemo"这个压缩包文件，你将能够看到一个实际的SHFB项目，包括配置文件、源代码注释示例、生成脚本等。通过对这个示例的研究，你可以快速掌握SHFB的使用，从而为自己的.NET项目创建高质量的文档。

资源推荐

资源详情

资源评论

收起资源包目录

SHFB生成CHM的Demo （133个子文件）

Welcome.aml 3KB

VersionHistory.aml 1007B

v1.0.0.0.aml 741B

chmdemo.metadata.v7.bin 245KB

chmdemo.projects.v7.bin 148KB

project.nuget.cache 560B

Documentation1.shfbproj.AssemblyReference.cache 509B

chmDemo.assets.cache 477B

chmDemo.genruntimeconfig.cache 66B

chmDemo.csproj.CoreCompileInputs.cache 66B

chmDemo.AssemblyInfoInputs.cache 66B

chmDemo.RazorAssemblyInfo.cache 66B

chmDemo.MvcApplicationPartsAssemblyInfo.cache 0B

ContentLayout.content 726B

HomeController.cs 1KB

chmDemo.AssemblyInfo.cs 1004B

Program.cs 812B

chmDemo.GlobalUsings.g.cs 770B

chmDemo.RazorAssemblyInfo.cs 742B

ErrorViewModel.cs 201B

.NETCoreApp,Version=v6.0.AssemblyAttributes.cs 198B

_Layout.cshtml 2KB

Error.cshtml 884B

Index.cshtml 239B

_ValidationScriptsPartial.cshtml 176B

Privacy.cshtml 144B

_ViewImports.cshtml 96B

_ViewStart.cshtml 35B

chmDemo.csproj 284B

bootstrap.css 199KB

bootstrap.rtl.css 199KB

bootstrap.rtl.min.css 159KB

bootstrap.min.css 159KB

bootstrap-utilities.css 70KB

bootstrap-utilities.rtl.css 70KB

bootstrap-grid.rtl.css 69KB

bootstrap-grid.css 69KB

bootstrap-utilities.min.css 52KB

bootstrap-utilities.rtl.min.css 52KB

bootstrap-grid.rtl.min.css 50KB

bootstrap-grid.min.css 50KB

bootstrap-reboot.css 6KB

bootstrap-reboot.rtl.css 6KB

bootstrap-reboot.rtl.min.css 5KB

bootstrap-reboot.min.css 5KB

chmDemo.styles.css 1KB

chmDemo.bundle.scp.css 1KB

_Layout.cshtml.rz.scp.css 1KB

_Layout.cshtml.css 924B

site.css 194B

chmDemo.dll 46KB

chmDemo.dll 15KB

chmDemo.GeneratedMSBuildEditorConfig.editorconfig 2KB

apphost.exe 146KB

chmDemo.exe 146KB

favicon.ico 5KB

jquery.js 281KB

bootstrap.bundle.js 204KB

bootstrap.js 145KB

bootstrap.esm.js 136KB

jquery.min.js 87KB

bootstrap.bundle.min.js 77KB

bootstrap.esm.min.js 70KB

bootstrap.min.js 58KB

additional-methods.js 52KB

jquery.validate.js 50KB

jquery.validate.min.js 24KB

additional-methods.min.js 22KB

jquery.validate.unobtrusive.js 19KB

jquery.validate.unobtrusive.min.js 6KB

site.js 230B

staticwebassets.build.json 48KB

staticwebassets.pack.json 13KB

staticwebassets.development.json 9KB

chmDemo.staticwebassets.runtime.json 9KB

DocumentLayout.json 6KB

project.assets.json 3KB

chmDemo.csproj.nuget.dgspec.json 3KB

launchSettings.json 681B

chmDemo.runtimeconfig.json 416B

chmDemo.deps.json 413B

appsettings.json 151B

appsettings.Development.json 127B

LICENSE 1KB

bootstrap.rtl.min.css.map 646KB

bootstrap.css.map 524KB

bootstrap.rtl.css.map 524KB

bootstrap.min.css.map 439KB

bootstrap.bundle.js.map 416KB

bootstrap.bundle.min.js.map 320KB

bootstrap.js.map 283KB

bootstrap.esm.js.map 282KB

bootstrap.esm.min.js.map 217KB

bootstrap.min.js.map 212KB

bootstrap-grid.rtl.css.map 192KB

bootstrap-grid.css.map 192KB

共 133 条

F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\appsettings.Development.json F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\appsettings.json F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\chmDemo.staticwebassets.runtime.json F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\chmDemo.exe F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\chmDemo.deps.json F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\chmDemo.runtimeconfig.json F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\chmDemo.dll F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\chmDemo.pdb F:\Code\chmDemo\chmDemo\bin\Debug\net6.0\chmDemo.xml F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.GeneratedMSBuildEditorConfig.editorconfig F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.AssemblyInfoInputs.cache F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.AssemblyInfo.cs F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.csproj.CoreCompileInputs.cache F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.MvcApplicationPartsAssemblyInfo.cache F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.RazorAssemblyInfo.cache F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.RazorAssemblyInfo.cs F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\staticwebassets.build.json F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\staticwebassets.development.json F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\staticwebassets\msbuild.chmDemo.Microsoft.AspNetCore.StaticWebAssets.props F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\staticwebassets\msbuild.build.chmDemo.props F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\staticwebassets\msbuild.buildMultiTargeting.chmDemo.props F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\staticwebassets\msbuild.buildTransitive.chmDemo.props F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\staticwebassets.pack.json F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\scopedcss\Views\Shared\_Layout.cshtml.rz.scp.css F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\scopedcss\bundle\chmDemo.styles.css F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\scopedcss\projectbundle\chmDemo.bundle.scp.css F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.dll F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\refint\chmDemo.dll F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.xml F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.pdb F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\chmDemo.genruntimeconfig.cache F:\Code\chmDemo\chmDemo\obj\Debug\net6.0\ref\chmDemo.dll

评论收藏

内容反馈