如何使用 Sandcastle 帮助文件生成器在帮助文件中显示代码示例？答案

【问题标题】：How do I get Code Examples to show in the Help file using Sandcastle Help File Builder?如何使用 Sandcastle 帮助文件生成器在帮助文件中显示代码示例？
【发布时间】：2009-08-15 12:50:08
【问题描述】：

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

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

我的代码中的示例如下所示：

    /// <summary>
    /// Connects to the server
    /// </summary>
    /// <example> Connecting to localhost
    /// <code>
    /// Client client = new Client(true);
    /// EndPoint localhost = new IPEndPoint(IPAddress.Loopback, 8888);
    /// client.Connect(localhost);
    /// </code>
    /// </example>

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

【问题讨论】：

标签： .net documentation-generation sandcastle shfb

【解决方案1】：

答案是你不需要做任何事情。在 Documentation Sources 下，我添加了我的 .csproj，这是使用 bin/Debug 下的文件，这些文件没有被重建。所以我的答案是将文档源更改为bin/Release 下的文件。愚蠢，我知道。我会把这个留在这里，以防其他人有同样的问题。

【讨论】：