问题标签 [sandcastle]

我正在尝试评论我向客户公开的 API (.Net)。我通过使用 XML 注释和通过 SandCastle 提取来做到这一点。

这一切都很好而且很花哨，但是我对 API 进行了单元测试，并且认为这些代码可以很好地放在示例标签中。

那么有人知道提取单元测试代码并放入示例标签的好方法吗？或者有人有更好的想法吗？

当然，我使用 API 重新分发单元测试，但最好将它们包含在文档中。

我对 SandCastle 的输出非常满意，但我还希望在 HTML 输出中包含一些搜索功能，这可能吗？

我即将编写从 Sandcastle HTML 输出到 MOSS 实用程序的导入。在我这样做之前，我只想问是否有人知道已经可以完成此任务的工具？

哦，如果问题因为与编程无关而被关闭，请发表评论。

早上好，下午，晚上或晚上（取决于您的时区）。

这只是关于 C# 中 XML 注释的一般问题。我从来没有非常热衷于评论我的程序，我一直是一个冗长的变量/属性/方法命名器，让代码自己说话。如果我正在编写相当混乱的代码，我会写评论，但在大多数情况下，我不会写很多评论。

我正在阅读 .NET、Sandcastle 中的 XML 注释和 codeplex 上的帮助文件生成器，它让我走上了想要记录我的代码并为那些必须深入研究我的人生成一些很好、有用的文档的道路。当我不再在这里时的代码。

我的问题是关于标准和约定的。是否有“好的”XML 注释指南？你应该评论每一个变量和属性吗？每种方法？我基本上只是在寻找有关如何编写好的注释的提示，这些注释将由 sandcastle 编译成好的文档，这样其他程序员在最终不得不处理我的代码时就不会诅咒我的名字。

提前感谢您的意见和建议，Scott Vercuski

在 C# 的 XML 文档注释中，有没有办法将两个或多个函数标记为彼此重载，以便它们自动相互引用？理想情况下，它们也会以某种方式被分组在沙堡生成的文档中。

目的：通常，我想链接到这组函数，例如在实用函数列表中，只需提及其中一个重载，并让其他重载从那里很容易被发现。

目前我正在添加链接，但这很乏味。

我正在尝试利用Sandcastle来帮助构建系统文档，但出于某种奇怪的原因，我的<summary>数据都没有显示在 chm 中……有没有人使用 VB 获得了最新版本的 Sandcastle 和 VS2008 的成功？

我们利用sandcastle（和SHFB）从内联 XML 注释生成类库文档。它是维护完整且专业的参考 + 概述文档（包括正确的代码示例）的绝佳工具。

不幸的是，它也很慢。这是迄今为止我们自动化构建中最耗时的步骤，并且开始受到影响。有什么办法可以加快速度吗？

是否可以从 XSD 文件创建 CHM 文件或 HTML 帮助（类似于 Sandcastle 创建的帮助）？xs:documentation节点中的文本包含文档。

我拥有的一个 XSD 文件的示例片段是

我正在尝试使用 msbuild 中的 SandCastle 帮助文件生成器生成帮助文件，但出现以下错误：

SandcastleBuilder.Utils.BuilderException：SchemaVersion 无效或缺失

这是什么意思？我该如何解决这个错误？

如何让 Sandcastle Help File Builder 从使用 MSBuild 构建的项目中创建帮助文件？