如何使用 Sandcastle 帮助文件生成器在帮助文件中显示代码示例?
我正在使用 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>
我是否需要配置一些我不知道的项目属性?
I'm using Sandcastle Help File Builder GUI and I can't seem to get code examples in my comments to appear in the help file output.
I'm generating Help 1.x and MSDN-style HTML documentation.
The examples look like the following in my code:
/// <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>
Do I need to configure some Project Property which is unknown to me?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
答案是你不需要做任何事情。 在文档源下,我添加了.csproj,并且这是使用
bin/Debug
下未重建的文件。 所以我的答案是将文档源更改为bin/Release
下的文件。 愚蠢,我知道。 我会将其留在这里,以防其他人遇到同样的问题。The answer was you don't need to do anything. Under Documentation Sources I'd added my .csproj and this was using the files under
bin/Debug
which weren't being rebuilt. So the answer for me was to change the Documentation Sources to the files underbin/Release
. Stupid, I know. I'll leave this here in case anyone else has the same problem.