【问题标题】:put example code in documentation by using sandcastle使用沙堡将示例代码放入文档中
【发布时间】:2010-11-01 09:41:32
【问题描述】:

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

【问题讨论】:

    标签: c# documentation sandcastle


    【解决方案1】:

    您尝试过<example><code> 标签吗?它应该做你想做的。

    <summary> ... </summary>
    <example>This is a code example:
      <code> ... </code>
    </example>
    

    【讨论】:

    • 如果您使用的是 SHFB (codeplex.com/SHFB),您也可以添加代码的语言,这样您还可以获得代码着色。
    猜你喜欢
    • 2016-08-11
    • 2014-12-22
    • 2012-03-27
    • 1970-01-01
    • 1970-01-01
    • 2020-02-05
    • 1970-01-01
    • 2011-01-25
    • 1970-01-01
    相关资源
    最近更新 更多