DocMounter帮助文件生成器

{A}
{S0}内容的表{A16}{A17}简介
由于是首次发布的Visual Studio。NET，它已经可以直接在代码文件类和定义标准的文档部分（如摘要，备注，参数说明等），其中包含标准的标签（如成员引用，两列的表格，清单等）。但对我们来说，开发人员，这是很不方便，充分证明我们的类和创造这么长的路段，直接在代码中的言论。在文档创建一个技术作家和代码是由开发人员创建的情况下也是如此，他们的工作与一个单一的文件，这是不太合适的。该实用程序，我们创建，DocMounter，是一种从文档中分离出来的代码没有损失由Visual Studio所提供的便利。
DocMounter允许您轻松地创建MS Visual Studio中的XML文档文件，为您的产品。这些文件可以用于在Visual Studio（IntelliSense和对象浏览器中）你的产品，你也可以用它们来为您的产品在一个使用这种自动帮助建设工具NDoc的和沙塔点击现代化的帮助。创造历史
DocMounter最初是为我们的内部需求，即以创建全功能的文件为我们的组件之一。一步一步的工具改进，终于，它已成为一个易于使用的应用程序，可用于其他开发人员有用的。主要特点
DocMounter可让您执行下列任务:
输入如摘要，备注，例如标准的部分，也见等类和其成员通过一个可视化界面。
添加标签，如通过一个可视化界面，代码，列表，表等。
创建的类及其成员（XML文档语法）使用相同的语法其他主题。
生成XML文档文件，以后可以使用编译一个完整的文档NDoc的，沙塔，或其他公用事业的。
生成额外的主题（主题不相关的一个特定的类或它的成员）的HTML文件。
生成一个HTML文件从所有其他主题。后来，这个文件可能会略有编辑，转换成DOC，RTF或PDF格式，并作为一个手册使用。
NDoc的整合，沙塔，或其他实用工具来创建一个编译HXS帮助文件，从XML文档和其他HTML主题:
易启动
让我们首先帮助解决方案的构建与DocMounter。
应用程序启动后，你会看到这样一个启动对话框:
{S2}
在此对话框中单击"新建"按钮，然后选择你想要的文件库，将创建一个新的项目。
该项目已被创建后，你可以看到成员的主要形式左侧树中指定的程序集的市民，例如:
{S3}
顺序选择每个成员大会和成员树的右侧部分进入其描述。每一个成员都有其自己的一套，第顶部的标签，你可以在它们之间切换:
{S4}的
，您还可以在描述中使用特殊的标记。要插入一个标记，设置插入符的地方，你要插入的标记，单击{S5}工具栏按钮，在对话框中指定的标签将出现:
{中六}
例如，如果你要插入一个成员的引用，选择左侧的"请参阅"项目，选择会员参考在右边的树，并单击"确定"按钮。
当你输入了所有必要的说明，您可以构建的帮助类型之一。要建立一个完整的帮助解决方案，推动{七}工具栏按钮。建设完成后，点击{S8}工具栏按钮来查看结果。
指定输出文件夹，默认情况下，在项目属性中（该项目的主要菜单项的属性项目）;结果保存'10Tec DocMounter输出的文件夹"我的文档"文件夹"。项目属性
创建一个新项目后，你应该指定它的属性（如输出路径，标题等）。你可以用"项目"菜单上的"属性"项。选择此项目，你会看到对话框允许你指定所有的项目属性:
{S9}
DocSet名单[建设帮助解决方案和唯一的额外主题意识]。在MSHelp 2每个主题可以有一个或多个DocSet属性。 DocSet是一个属性，它是由2 MSHelp用于过滤和搜索的主题。下面是微软DocSet属性写入:产品或技术所产生的文档需要DocSet，在帮助查看器用于过滤属性标签。它是一种方便的方法，包括特别是在过滤器中的文件设置。在适用的情况下，适用于每个主题的多个值。预先定义的quot; Visual Basic和Relatedquot过滤​​器，例如，看起来像这样:"DocSetquot ="视觉Basicquot;或"DocSetquot; = quot; NETFrameworkquot;或"DocSetquot; = quot; NETFrameworkExtenderquot;或"; DocSetquot"; ="DHTMLquot;或"DocSetquot; = quot; XMLquot;或（"; DocSetquot"="MSDNquot;和quot; ProductVersquot; = quot; kbVBp700quot;）
如果你想输入几个DocSet属性，用逗号将它们分开。建设帮助解决方案或其他主题时，所有进入DocSet属性将被添加到每一个主题。
帮助[只为建设帮助解决方案和其他主题，有效]命名空间。允许您指定命名空间，将登记您的帮助，帮助英寸的命名空间是由一个MSHelp文档资源管理器用来浏览主题帮助。例如，让我们看看一个主题地址NET Framework文档。MS -帮助:/ / MS.NETDEVFX.v20.en/cpref2/html/T_System_Object.htm
第一部分的地址，MS -帮助，告诉的资源管理器，它应该使用的MS -帮助协议来浏览文件; MS.NETDEVFX.v20.en，第二部分，是该主题的命名空间登记。
当您注册您的帮助集合，它是注册进入这一领域的命名空间。该命名空间包含几个部分组成。其第一部分是您的公司名称，第二部分是文档描述的产品的名称，接下来的部分是产品的版本，最后一个是区域设置代码。
如何DocMounter使用此命名空间？首先，当你建立帮助解决方案，由此产生的HXS（编译帮助文件）注册此命名空间，使在一个MSHelp文档资源管理器观看。此外，帮助命名空间用于建设其他主题时，当创建本地成员的参考链接。
系统帮助命名空间[有效]建设帮助解决方案和其他主题。这是使用的命名空间参照系统成员时。当一个主题是建立，系统成员的所有引用替换MSHelp 2环节。这些环节包括帮助命名空间和A -指数的成员。例如，链接LT; CREF ="电话:System.Objectquot; GT，LT将取代; MSHelp:链接关键词= quot; frlrfSystemObjectClassTopicquot; indexMoniker = quot; DefaultAssociativeIndexquot;命名空间= quot; MS -帮助: / / MS.NETDEVFX.v20.enquot;的TabIndex ="0quot; GT; System.Objectlt; / MSHelp:linkgt;，"MS.NETDEVFX.v20.enquot;是在这一领域中所指定的命名空间。这意味着，链接点，在Microsoft frlrfSystemObjectClassTopic A -指数的话题。NET Framework 2.0版帮助收集。
输出。允许您指定为构建所有类型的输出文件夹。如果摘要领域的XML是空的，简要描述XML文档保存到的文件夹中的程序集位于。描述类及其成员
DocMounter允许您描述程序集的所有市民。当你已载入一个项目或创建一个新的，你可以看到项目的集会在位于DocMounter主窗口的左侧的成员树的所有成员。当您选择此树中的一个成员，其描述部分出现在右侧的成员树。每个成员都有其自己的一套第。有些部分共同所有类型的成员（例如，"摘要"部分是目前在每一个成员的类型）。编译帮助解决方案后，这些路段都聚集到一个单一的主题。
您可以键入任何文字成一节描述，将直接传送到输出主题。此外，该文本可能包含特殊标记。这些标签可让您使其他类型和成员的引用，创建表和列表等等。
标记是在Visual Studio中使用的标记非常相似。NET文档类及其成员。你可以阅读更多有关微软支持在下面的文章标签的:
{A18}
的成员描述，您可以使用Microsoft支持以下标记:LT; seegt;，LT; codegt;，LT; paramrefgt;，LT; listgt。 （注:你不应该使用LT; paragt;标签，作为DocMounter会自动添加在这些地方换行标签），您可以进入这些标记手动或使用DocMounter可视化界面提供一个自动化的方法。如果你想插入一个标签，移动插入符的地方，你要插入标签，并按下Ctrl T组合键（或按下"插入"标签的工具栏按钮，或插入主菜单项目中选择插入标签项目） 。会出现"插入"标签的形式:
{中六}
，在左侧的形式，你可以看到DocMounter支持的标记的完整列表。这些标签不支持微软的XML文档的语言并没有提供给成员的说明（例如多列表）进入。当您选择一个标签，从这个名单反映了标签的参数的字段出现在右侧的形式。填写在这些领域，然后按"确定"按钮。该标记将被插入到描述。
说明文字，例如"这是一个参考的LT;见CREF ="电话:。System.Objectquot; / GT的成员"，它包含一个标签，将被编译成下列文字输出主题:
{S11}
如果你想，尖括号出现在一个文档，使用"放大器; LT;的文本和"放大器; GT";。例如"放大器; LT;角度bracketsamp的文本; GT"将编译:
{S12}创建和管理额外的主题
另外的成员描述，DocMounter允许你创建额外的主题不相关的特定成员。这些主题的内容是不包括在完整的XML和XML有摘要，但您可以创建单独的HTML文件，这些主题，这些主题也包括帮助解决方案（编译HXS文件，这是通过一个内置的添加中）。
要创建一个额外的话题，按"添加"按钮，这是位于下DocMounter主要形式的主题树。下一步"添加"按钮，你会发现"删除"按钮，它允许你删除选定的主题。您也可以添加，删除，或重新命名，右键单击成员树中的一个主题时，会出现上下文菜单中的主题。创建一个额外的主题后，您可以编辑它作为一个普通的成员，请输入纯文本，并插入标签。生成XML帮助
DocMounter允许你建立两种类型的XML的帮助文档:XML摘要和完整的XML。只有第一个店的帮助总结部分，是比后者小。什么是拟用于？此XML文档的目的是一起分发。NET程序集，记录，将使用由Visual Studio的IntelliSense。当你在Visual Studio代码编辑器中键入代码时，IntelliSense会显示您的类型和其成员的简短描述。它从这些描述的是位于相同的文件夹在您的程序集所在的XML文档。所有的XML文档的其他部分，如果它们存在，不是由IntelliSense使用，并因此并不需要在这种类型的XML文档。
完整的XML，XML文档，第二类是由其他公用设施，如NDoc的和沙塔的使用，如HXS（MSHelp 2编译的帮助格式），生成完整的帮助文件CHM等这个XML文件包含所有章节的帮助（摘要，备注，异常等）。
建立与摘要的XML的帮助，选择生成的主菜单项目的XML摘要项目，推动构建XML概要文件工具栏按钮，或按CTRL移位S组合键。
要建立完整的XML文档，生成的主菜单项目选择的完整的XML项目，推动建立完整的XML描述文件工具栏按钮，或按CTRL移位C组合键。增建主题
由于XML文档不支持主题不直接相关的成员，DocMounter允许你建立单独的HTML文件，其他主题。这些HTML文件可以稍后手动纳入一个帮助项目。
为了建立额外的主题，选择其他主题的生成主菜单项目的项目，推动建立更多的主题工具栏按钮，或按CTRL移位T组合键。建筑帮助解决方案
DocMounter本身不允许你建立HXS（MSHelp 2编译的帮助格式），资料和其他帮助文件。只允许你构建XML文档，NDoc的和沙塔等免费实用以后可以转换成这些格式。但它有可能整合这些实用程序之一添加到DocMounter给你自动生成帮助文件的能力。如果某个加载项中（文件名称TenTec.Utils.HelpBuilder.dll）是在相同的文件夹与DocMounter的位置，你可以在一个单一的步骤建立一个完整的帮助解决方案。
目前DocMounter分布只有一个添加的NDoc的，这是重新编译。NET Framework 2.0的修改后的版本的基础上。此加载项允许您构建MSHelp2（HXS）文件，并查看它们。它要求您的计算机上安装Microsoft帮助2 SDK。 SDK是Visual Studio SDK中的一部分，可以从以下位置取决于您的Visual Studio版本下载:
2003年的VS:{A19}
2005年的VS:{A20}
编译HXS文件，选择生成的主菜单项目帮助解决方案项目，推动建立帮助解决方案的工具栏按钮，或按CTRL移位H组合键。建设手册
，随着DocMounter你不能只建立单独的HTML的主题，但你也可以创建一个HTML文件，包含了所有的其他主题。这个文件是不是一个完整的的手册 - 它允许你创建一个完整的手册，它是一个草案。你可以改变文档的样式，添加一个表的内容，转换成另一种格式，如DOC，RTF，PDF格式等，例如，它得到了一个现成的打印手册，你可以打开这个HTML文件在MS Word中，添加标题和内容表，并保存为Word文档？？这一切。
要创建手册，选择生成的主菜单项目手册项，推动建立手动工具栏按钮，或按CTRL移位M键组合。创建一个自定义加载项
DocMounter本身不允许你建立HXS（MSHelp 2编译的帮助格式），CHM等帮助文件。只允许你构建XML文档，NDoc的和沙塔等免费实用以后可以转换成这些格式。但它有可能结合起来，作为一个附加的实用程序之一。 DocMounter当前版本允许你插入只有一个附加时间（这是在99％的情况下，因为如果你建立你的产品的帮助文件，你一般只使用一个这样的工具）。
在DocMounter仅仅是一个类库，这是在同一文件夹中的DocMounter中的名称TenTec.Utils.HelpBuilder.dll。这个库应该包含一个类，它实现IHelpBuilder和IAdditionalTopicHelper接口。这两个接口描述在TenTec.Utils.IHelpBuilder.dll库，你可以找到在DocMounter安装的文件夹。
目前添加NDoc的基础是包含在DocMounter。帮助文件
本文仅包含DocMounter手册的主要部分。 DocMounter充分说明可以在手册和帮助安装。更改日志
2007年2月21日。 V1.10，建立0000。文章张贴。
2007年3月20日。 V1.10，建立0001。[修正]现在DocMounter支持新闻部从正常（96）不同。[固定]当一个嵌套代表库记录，发生了错误。