【发布时间】:2013-03-19 19:44:29
【问题描述】:
我正在使用 Codeplex 与 VS.NET 2012 集成的当前版本的 Sandcastle 来构建 .cmh 帮助文件。正在创建帮助文件,但我似乎无法在帮助文件中发出任何 <code> 块。我一直在使用以下简单示例:
/// <summary>
/// This is the summary
/// </summary>
/// <code>var s;</code>
public string SomeValue { get; set; }
当我查看输出 .chm 文件时,var s; 代码不存在任何地方。我做了以下事情:
- 在 Sandcastle 项目属性中添加了对
Code Block Component的引用。 - 尝试制作标签
<code lang="C#">var s;</code>和<code language="C#">var s;</code>,但都没有效果。 - 阅读以下站点上详细说明此过程的文档,但无济于事:
https://www.simple-talk.com/dotnet/.net-tools/taming-sandcastle-a-.net-programmers-guide-to-documenting-your-code/
http://www.ewoodruff.us/shfbdocs/
该示例显然是一个简化版本,但我只是想在这里完成基础工作。我做错了什么或遗漏了什么?
【问题讨论】:
-
我不认为
code标签可以单独使用,试着把它放在<example>标签里面,比如<example><code>var s;</code></example>。 -
@vcsjones - 不错的电话,我发誓我之前尝试过,但我必须有一些解释。我建议将您的建议作为答案提供一个完整的示例,以便我标记它。有趣的是,“驯服沙堡”的文章并没有这样显示。
标签: c# sandcastle