使用sandcastle将示例代码放在文档中

asl*_*nci 8 c# documentation sandcastle

我正在使用sandcastle帮助文件构建器从我的c#代码的xml注释中生成文档文件.你知道如何将代码示例包含在帮助文件中,如msdn样式吗?

tan*_*ius 12

你试过<example><code>标签了吗?它应该做你想要的.

<summary> ... </summary>
<example>This is a code example:
  <code> ... </code>
</example>
Run Code Online (Sandbox Code Playgroud)

  • 如果你正在使用SHFB(http://www.codeplex.com/SHFB),你也可以添加代码的语言,这样你也可以获得代码着色. (4认同)