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

时间:2009-08-15 12:50:09

标签: .net documentation-generation sandcastle shfb

我正在使用Sandcastle帮助文件生成器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>

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

1 个答案:

答案 0 :(得分:3)

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