问题标签 [sandcastle]

Sandcastle 有一个相当复杂的 XML MAML用于生成概念帮助，正如2007 年的一篇不错的介绍中所讨论的。这与 Doxygen 在编写内容的便利性和对页面生成的控制方面相比如何？

我非常喜欢使用 Doxygen页面工具来编写这样的概念性帮助，包括对设计问题的讨论。它的结构要少得多 - 有主页，然后您可以通过添加带有子页面或参考命令的链接来选择如何对页面进行分组。

我也喜欢我可以在我的 doxygen 页面中包含随意的 Graphviz 图表，或者使用内联片段或引用外部文件。

我注意到我的沙堡文档缺少任何放在枚举成员上的注释，但是 Visual Studio 生成的 XML 文档文档确实包含丢失的数据。

考虑到我有一个复杂的类结构，其中许多元素继承自其他元素。我可能GetStuff(string stuffName, int count)在接口中定义了一个方法，该方法由其他接口继承，然后由抽象类抽象实现，然后在具体类中显式实现等等......

我应该如何处理继承的成员，例如GetStuff()在使用 XML 注释记录我的代码时，这些注释将与 Doxygen 或 Sandcastle 等工具一起使用？在每个级别复制和粘贴相同的描述似乎是错误的。我应该在接口级别与具体类级别考虑不同的受众吗？例如，接口上 GetStuff() 的文档可能会考虑实现接口的人，而具体级别的文档可能会考虑将使用该类的人？

我的图书馆使用代码合同。

有没有办法将这些合同合并到沙堡生成的文档中？

我在一个沙堡项目中添加了一个代码片段。但是，代码片段没有显示在生成的帮助文件中？如何指定我要添加它？

如何使用 Sandcastle 构建 CHM / HTML 文档？可以从 XML 构建 HTML 文件还是必须使用 .cs 和 dll 文件？

有谁知道是否有一个 XML 评论标签允许人们从评论生成器（特别是沙堡）中隐藏文本？

例如，给定以下内容：

我希望 ... 标签之间的文本不会出现在任何沙堡生成的输出中。

有什么想法吗？

我正在试用 Sandcastle 帮助文件生成器。如果我从 gui 运行构建，则会收到此错误：

找不到 C:\Program Files\MSBuild\Microsoft\VisualStudio\v9.0\WebApplications\Microsoft.WebApplication.targets"

这是因为它位于 C:\Program Files (x86) 目录中。

那么如何配置为使用该目录呢？

我正在使用沙堡来验证我的帮助文件。

编辑 AML 文件很痛苦，因为没有智能感知支持 - 不像 Visual Studio 中的 ASP.NET 或 XAML。

有没有更好的办法？

我正在使用 sandcastle 来构建我的帮助文件。

有没有办法从实际的 C# 文件中添加代码示例？理想情况下，我会有带有区域的 C# 文件，从沙堡引用该区域。然后 Sandcastle 将在构建时嵌入该区域的内容。这可行吗？