问题标签 [sandcastle]

我正在使用沙堡帮助文件生成器从我的 c# 代码的 xml 注释生成文档文件。你知道如何将代码示例包含到帮助文件中，比如 msdn 样式吗？

当我使用 Sandcastle Helpfile Builder 创建 chm 时，如何将 xmldoc 块中的列表呈现为有序列表？

以下不起作用：

在我试图解决的特定情况下，列表位于 <summary/> 元素中。

我只是想知道——Sandcastle 的最后一个版本是从 2008 年 5 月开始的，它仍然被列为预发布软件/CTP，甚至不再获得许可，正如 EULA 特别指出的那样：

2.期限。本协议有效期至 2007 年 9 月 1 日或软件的商业版本，以先到者为准。

由于 Sandcastle 无论如何都相当“沉重”，我只是想知道它是否仍然是正确的使用方法，或者是否有其他方法可以创建 XmlDoc 文档？（替代方案 = 我可以从我的构建中运行以生成至少 HTML，最好是 PDF）。

（使用 GUI 构建器）

有谁知道这个东西想要从 Html Help 2.x 功能集中得到什么？

它在它生成的任何非本地 .chm 文件中不断抛出“访问被拒绝”错误，并指定“ms-help://hx/hxruntime/hxlink.htc”。生成的网站同样的错误。让我们不要陷入这样一个事实，即如果我在除硬盘驱动器之外的任何地方生成 .chm，则所有链接都已失效，无论文件后来移动到何处。

叹

令我恼火的是，我使用的是 Microsoft 网站（2008 年 5 月）新下载的 Sandcastle。所以它不像是旧版本。我只是在这里错过了一些巨大的东西吗？

我已经用 Sandcastle 生成了我的项目的网站文档。这个网站使用框架，所以当我点击网站时，我在浏览器中的 URL 不会改变。

当我浏览使用 Sandcastle 生成的网站文档时，我希望在浏览器中更改 URL。为什么？因为我想从我的开发人员环境的其他部分链接到文档的具体子页面。

此外，我希望此链接永久有效。因此，当我从项目的新版本再次生成文档时，链接不会改变，因此我不需要将所有链接都更改为新的。

这可能吗？如何实现？

默认情况下，我看到Sandcastle正在生成以 GUID 命名的 HTML 页面和链接。可以以某种方式更改此内容以生成页面的用户/SEO 友好名称吗？IE。而不是f987d4ff-cabc-10af-86cd-620978605d86.htm我希望它创建'namespace.class.method.htm'，类似于.Net MSDN 文档的生成方式。

SandCastle 无法处理我们的类库，因为它在 XSL 转换期间崩溃并出现 OutOfMemoryException 异常。

除了明显的购买更多内存之外，我们能做些什么呢？问题是，这是我们的开发机器在 32 位操作系统上具有 3.3GB 内存，所以基本上我们要么升级到 64 位和更多内存（这暂时不会发生），要么设置一个虚拟服务器来使用大量内存执行此操作（这将影响生产服务器）。

我严重怀疑我们有世界上最大的需要帮助文件的类库，那么我们有什么选择呢？是否有我们忘记关闭的神奇“不要因内存不足错误而崩溃”设置？

我们使用 Sandcastle 通过构建过程生成源代码文档。这对于为类、方法、属性等创建 API 级别文档非常有用。此外，Sandcastle 允许您将摘要添加到命名空间以及“概念内容”。我们正在为各种“操作方法”主题创建概念内容文件，例如架构图等。所有这些都很好。

有谁知道 Sandcastle 是否有办法对这些内容进行分组？默认情况下，Sandcastle 似乎在帮助树的根目录中创建所有这些 API 文档以及任何概念内容。我想在树中有一个像“API 文档”这样的节点，并在该节点下拥有所有源代码文档，然后对我们拥有的其他文档主题进行其他分组。我正在努力寻找在 Sandcastle 中做到这一点的方法。我已经看到其他商业产品在他们的 chm 文件中有这种类型的分组，但我怀疑他们使用的是 RoboHelp 之类的东西。

有没有办法通过 Sandcastle 实现这一目标？

我将使用 Sandcastle 生成 API 文档 - 我在该网站上找不到任何有关如何执行此操作的指南。有没有人推荐任何快速入门指南？

我正在使用 Sandcastle Help File Builder GUI，我似乎无法在我的注释中获取代码示例以显示在帮助文件输出中。

我正在生成 Help 1.x 和 MSDN 样式的 HTML 文档。

这些示例在我的代码中如下所示：

我是否需要配置一些我不知道的项目属性？