Sandcastle(.net程序集CHM帮助文件生成器)_sandcastlechm需要什么样的工程资源-CSDN文库

共816个文件

gif：436个

xml：148个

xsl：51个

1星需积分: 10 184 浏览量 2011-07-28 12:16:13 上传评论收藏 6.87MB RAR 举报

《Sandcastle：.NET程序集CHM帮助文件生成器详解》在软件开发过程中，文档是不可或缺的一部分，它为开发者提供了清晰的指引和参考。在.NET框架中，Sandcastle工具正是用于生成高质量、详尽的程序集文档，尤其是CHM（Compiled Help Manual）帮助文件，这种格式通常用于离线查看，方便开发者随时查阅。本文将深入探讨Sandcastle的工作原理、使用方法以及其在生成.NET程序集文档中的重要性。一、Sandcastle简介 Sandcastle是由Microsoft开源的一个项目，主要用于生成.NET Framework程序集的API文档。它能够从元数据中自动提取信息，包括类、接口、方法、属性等，然后组织成易于阅读的HTML文档或CHM文件。Sandcastle的输出格式可以定制，满足不同开发者的需求，而且支持多语言，使得生成的文档更具有国际化特性。二、工作流程 Sandcastle的工作流程大致分为三个主要步骤： 1. **提取元数据**：Sandcastle通过反射技术读取.NET程序集的元数据，这包括所有类型、成员及其关联信息。 2. **构建文档模型**：它将元数据转换为内部文档模型，这个模型包含了所有要展示的文档元素，如类、方法、注释等。 3. **生成文档**：基于文档模型，Sandcastle使用XSLT转换模板生成最终的HTML或CHM文件。用户可以根据需要自定义样式和布局。三、使用Sandcastle 使用Sandcastle生成文档通常需要以下几步： 1. **安装和配置**：下载并安装Sandcastle，然后配置项目的构建环境，包括设置输入的程序集、输出格式、语言等。 2. **创建项目**：使用Sandcastle的项目文件（.shfbproj）创建一个新项目，添加需要生成文档的程序集。 3. **定制输出**：利用Sandcastle提供的各种选项和插件，定制文档的外观和内容，例如添加版权信息、自定义主题等。 4. **生成文档**：运行构建过程，Sandcastle会根据配置生成相应的CHM文件或其他格式的文档。四、Sandcastle的优势 1. **自动化**：Sandcastle能自动从程序集中提取文档信息，大大减少了手动编写文档的工作量。 2. **完整性**：生成的文档包含了.NET程序集的全面信息，有助于开发者理解和使用代码库。 3. **可定制**：用户可以通过修改XSLT模板和配置文件，实现对文档样式的高度定制。 4. **多语言支持**：Sandcastle可以生成多语言版本的文档，便于全球开发者使用。五、应用实例在实际开发中，Sandcastle广泛应用于开源项目和商业软件的文档生成。例如，许多NuGet包在发布时都会附带由Sandcastle生成的API文档，方便用户查阅和使用。总结，Sandcastle作为一款强大的.NET程序集文档生成工具，它的存在极大地提升了开发效率，降低了开发者之间的沟通成本。了解和掌握如何有效使用Sandcastle，对于提升软件开发的质量和用户体验至关重要。无论是个人开发者还是团队，都应将其视为提高开发效率的利器。

资源推荐

资源详情

资源评论

收起资源包目录

Sandcastle(.net程序集CHM帮助文件生成器) （816个子文件）

Default.aspx 295B

build_Sandcastle.bat 4KB

build_conceptual.bat 1KB

copyHavana.bat 556B

copyOutput.bat 503B

copyOutput.bat 496B

copyOutput.bat 490B

Test.chm 87KB

sandcastle-webref.config 9KB

sandcastle-scbuild.config 9KB

vs2005.config 9KB

sandcastle.config 9KB

conceptual.config 8KB

sandcastle-scbuild.config 8KB

hana.config 7KB

sandcastle.config 7KB

conceptual.config 7KB

sandcastle-scbuild.config 7KB

prototype.config 7KB

sandcastle.config 7KB

conceptual.config 6KB

MRefBuilder.config 5KB

xamlSyntax.config 3KB

ChmBuilder.config 968B

DBCSFix.exe.config 526B

web.config 217B

test.cs 4KB

Presentation.css 20KB

presentation.css 19KB

Presentation.css 17KB

presentation.css 7KB

tabs.css 2KB

site.css 1KB

syntax.css 275B

BuildComponents.dll 173KB

SyntaxComponents.dll 113KB

BuildAssemblerLibrary.dll 41KB

CommandLine.dll 33KB

test.dll 4KB

MrefBuilder.exe 657KB

SandcastleGui.exe 49KB

ChmBuilder.exe 37KB

VersionBuilder.exe 33KB

XslTransform.exe 33KB

SegregateByAssembly.exe 29KB

AggregateByNamespace.exe 29KB

BuildAssembler.exe 29KB

DBCSFix.exe 29KB

header_sql_tutorial_logo.GIF 3KB

kw_adm_dev_arch.gif 2KB

kw_dev_arch.gif 1KB

adm_dev_arch.gif 1KB

kw_adm_dev.gif 1KB

big_arch.gif 1KB

big_kw.gif 1KB

kw_adm_arch.gif 1KB

big_adm.gif 1KB

big_dev.gif 1KB

kw_dev.gif 1KB

adm_dev.gif 1KB

共 816 条

<html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp" xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:msxsl="urn:schemas-microsoft-com:xslt"> <head> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" /> <META NAME="save" CONTENT="history" /> <title>StoredNumber Members</title> <link rel="stylesheet" type="text/css" href="../styles/presentation.css" /> <link rel="stylesheet" type="text/css" href="ms-help://Hx/HxRuntime/HxLink.css" /> <script type="text/javascript" src="../scripts/EventUtilities.js"> </script> <script type="text/javascript" src="../scripts/SplitScreen.js"> </script> <script type="text/javascript" src="../scripts/Dropdown.js"> </script> <script type="text/javascript" src="../scripts/script_manifold.js"> </script> <script type="text/javascript" src="../scripts/script_feedBack.js"> </script> <script type="text/javascript" src="../scripts/CheckboxMenu.js"> </script> <script type="text/javascript" src="../scripts/CommonUtilities.js"> </script> <meta name="container" content="test" /> <meta name="file" content="AllMembers_T_TestNamespace_StoredNumber" /> <meta name="guid" content="AllMembers_T_TestNamespace_StoredNumber" /> <xml> <MSHelp:Attr Name="AssetID" Value="AllMembers.T:TestNamespace.StoredNumber" /> <MSHelp:TOCTitle Title="StoredNumber Members" /> <MSHelp:RLTitle Title="StoredNumber Members (TestNamespace)" /> <MSHelp:Keyword Index="A" Term="AllMembers.T:TestNamespace.StoredNumber" /> <MSHelp:Keyword Index="A" Term="frlrfTestNamespaceStoredNumberMembersTopic" /> <MSHelp:Keyword Index="K" Term="StoredNumber class" /> <MSHelp:Keyword Index="K" Term="StoredNumber class, all members" /> <MSHelp:Keyword Index="K" Term="TestNamespace.StoredNumber class" /> <MSHelp:Keyword Index="F" Term="StoredNumber" /> <MSHelp:Keyword Index="F" Term="TestNamespace.StoredNumber" /> <MSHelp:Attr Name="HelpPriority" Value="1" /> <MSHelp:Attr Name="DevLang" Value="VB" /> <MSHelp:Attr Name="DevLang" Value="CSharp" /> <MSHelp:Attr Name="DevLang" Value="C++" /> <MSHelp:Attr Name="Locale" Value="en-us" /> <MSHelp:Attr Name="TopicType" Value="kbSyntax" /> <MSHelp:Attr Name="TopicType" Value="apiref" /> </xml> </head> <body> <input type="hidden" id="userDataCache" class="userDataStyle" /> <input type="hidden" id="hiddenScrollOffset" /> <img id="collapseImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" title="Collapse image" /> <img id="expandImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" title="Expand Image" /> <img id="collapseAllImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" /> <img id="expandAllImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" /> <img id="dropDownImage" style="display:none; height:0; width:0;" src="../icons/dropdown.gif" /> <img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="../icons/dropdownHover.gif" /> <img id="copyImage" style="display:none; height:0; width:0;" src="../icons/copycode.gif" title="Copy image" /> <img id="copyHoverImage" style="display:none; height:0; width:0;" src="../icons/copycodeHighlight.gif" title="CopyHover image" /> <div id="header"> <table id="topTable" cellspacing="0" cellpadding="0"> <tr> <td> <span onclick="ExpandCollapseAll(toggleAllImage)" style="cursor:default;" onkeypress="ExpandCollapseAll_CheckKey(toggleAllImage, event)" tabindex="0"> <img ID="toggleAllImage" class="toggleAll" src="../icons/collapse_all.gif" /> <label id="collapseAllLabel" for="toggleAllImage" style="display: none;">Collapse All</label><label id="expandAllLabel" for="toggleAllImage" style="display: none;">Expand All</label> </span> <span> </span> <span id="devlangsDropdown" class="filter" tabindex="0"> <img id="devlangsDropdownImage" src="../icons/dropdown.gif" /> <label id="devlangsMenuAllLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: All </nobr></label><label id="devlangsMenuMultipleLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Multiple </nobr></label><label id="devlangsMenuVisualBasicLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual Basic </nobr></label><label id="devlangsMenuCSharpLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: C# </nobr></label><label id="devlangsMenuManagedCPlusPlusLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual C++ </nobr></label><label id="devlangsMenuJavaScriptLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: JavaScript </nobr></label></span> <span> </span> <span id="memberOptionsDropdown" class="filter" tabindex="0"> <img id="memberOptionsDropdownImage" src="../icons/dropdown.gif" /> <label id="memberOptionsMenuAllLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Show All </nobr></label><label id="memberOptionsMenuMultipleLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Filtered </nobr></label><label id="memberOptionsMenuProtectedLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Filtered </nobr></label><label id="memberOptionsMenuInheritedLabel" for="memberOptionsDropdownImage" style="display: none;"><nobr>Members: Filtered </nobr></label></span> </td> </tr> </table> <div id="devlangsMenu"> <input id="VisualBasicCheckbox" type="checkbox" data="VisualBasic,vb,'persist'" value="on" onClick="SetLanguage(this)" /> <label class="checkboxLabel" for="VisualBasicCheckbox">Visual Basic</label> <br /> <input id="CSharpCheckbox" type="checkbox" data="CSharp,cs,'persist'" value="on" onClick="SetLanguage(this)" /> <label class="checkboxLabel" for="CSharpCheckbox">C#</label> <br /> <input id="ManagedCPlusPlusCheckbox" type="checkbox" data="ManagedCPlusPlus,cpp,'persist'" value="on" onClick="SetLanguage(this)" /> <label class="checkboxLabel" for="ManagedCPlusPlusCheckbox">Visual C++</label> <br /> <input id="JavaScriptCheckbox" type="checkbox" data="JavaScript,vb,'persist'" value="on" onClick="SetLanguage(this)" /> <label class="checkboxLabel" for="JavaScriptCheckbox">JavaScript</label> <br /> </div> <div id="memberOptionsMenu"> <input id="ProtectedCheckbox" type="checkbox" data="Protected" value="on" onClick="SetMemberOptions(this, 'vis')" /> <label class="checkboxLabel" for="ProtectedCheckbox">Include Protected Members</label> <br /> <input id="InheritedCheckbox" type="checkbox" data="Inherited" value="on" onClick="SetMemberOptions(this, 'decl')" /> <label class="checkboxLabel" for="InheritedCheckbox">Include Inherited Members</label> <br /> </div> <table id="bottomTable" cellpadding="0" cellspacing="0"> <tr id="headerTableRow1"> <td align="left"> <span id="runningHeaderText">.NET Framework Class Library</span> </td> </tr> <tr id="headerTableRow2"> <td align="left"> <span id="nsrTitle">StoredNumber Members</span> </td> </tr> <tr id="headerTableRow3"> <td align="left"> <a href="T_TestNamespace_StoredNumber.htm">StoredNumber Class</a> <a href="#constructorTableToggle" onclick="OpenSection(constructorTableToggle)">Constructors</a> <a href="#methodTa

评论收藏

内容反馈