Question

我有一个课程，我想创建一个关于如何使用的简单示例。但是，当我在类声明中使用标记时，该示例不会出现在Sandcastle输出中。它适用于对象的成员，但不适用于类本身。沙堡可以处理这个吗？

我想做的一个例子是。

这是一个关于如何使用该类的示例。我怎样才能在课堂上加入这样的东西？

我想这样做：

/// <summary> My example class </summary>
/// <example>
///   <code>
///      // Example code on how to use the class
///   </code>
/// </example>
public class MyClass
{
    public string MyString {get;set;}
}

Answer 1

对于Sandcastle，可以通过使用您自己的标记变换定义修改main_sandcastle.xslt文件来创建自定义标记。您感兴趣的文件是：

变换/ main_sandcastle.xslt 内容/ shared_content.xml

Answer 2

由于包含泛型的示例，文档未正确解析，我不得不替换所有＆lt;与<和＆gt;与>。

我通过推杆测试了文档这是文档示例中的一个测试，它工作正常，但由于某种原因，它与我的真实代码无法正常工作。用适当的转义序列替换标签后，一切正常。

另请注意，声明的{T}无法正常工作，因为它是逐字打印而不是翻译成通用声明。虽然我希望在<code></code>语句中这样做，但我也希望List<string>声明也能正常工作。

一个类的C＃Documentation <example> <code>...</code> </example>

2 个答案: