8

我有一个类,我想创建一个关于如何使用的简单示例。但是,当我在类声明中使用标记时,该示例不会出现在 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;}
}
4

2 回答 2

1

对于 Sandcastle,可以通过使用您自己的标签转换定义修改 main_sandcastle.xslt 文件来创建自定义标签。您会感兴趣的文件是:

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

于 2012-09-12T17:10:20.780 回答
0

由于包含泛型的示例,文档未正确解析,我不得不将所有 < 替换为&lt;并且 >替换为&gt;

我已经通过将 this is a test 放在文档示例中测试了文档,它运行良好,但由于某种原因,它无法与我的真实代码一起正常工作。用适当的转义序列替换标签后,一切正常。

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

于 2012-09-04T21:46:37.957 回答