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

Question

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

我正在生成 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>

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

Answer 1

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