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

Question

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

我想做的一个例子是.

MSDN TcpClient文档

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

我想这样做:

/// <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

由于示例包含泛型，文档未正确解析，我必须将所有 < 替换为 ，将<> 替换为>。

我通过将这是一个测试放在文档示例中来测试文档，它工作得很好，但由于某种原因，它不能与我的真实代码正常工作。用适当的转义序列替换标签后，一切正常。

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