我正在使用 Codeplex 中与 VS.NET 2012 集成的当前版本的 SandcaSTLe 来构建 .cmh
帮助文件。正在创建帮助文件,但我似乎无法获得任何 <code>
在帮助文件中发出的 block 。我一直在使用以下简单示例:
/// <summary>
/// This is the summary
/// </summary>
/// <code>var s;</code>
public string SomeValue { get; set; }
当我查看输出 .chm 文件时,var s;
代码不存在任何地方。我已完成以下操作:
- 添加了对
Code Block Component
的引用在 SandcaSTLe 项目属性中。 - 尝试制作标签
<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/
该示例显然是一个简化版本,但我只是想在这里了解基础知识。我做错了什么或遗漏了什么?
最佳答案
我认为代码标签不允许单独存在,请尝试将其放入 <example>
中标签,例如 <example><code>var s;</code></example>
。所以这应该有效:
/// <summary>
/// This is the summary
/// </summary>
/// <example>
/// <code>var s;</code>
/// </example>
public string SomeValue { get; set; }
关于c# - 为什么我的代码块没有在 SandcaSTLe 帮助文件中呈现?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/15508997/