代码之家 › 专栏 › 技术社区 › galford13x

C#文档<example><code></类的代码></example>

sandcastle documentation .net c#

8

galford13x · 技术社区 · 13 年前

我有一个类,我想创建一个关于如何使用的简单示例。然而,当我在类声明上使用标记时,Sandcastle输出中不会出现该示例。它适用于对象的成员,但不适用于类本身。沙堡能应付吗?

我想做的一个例子就是。

MSDN TcpClient Documentation

这是一个关于如何使用类的示例。我怎么能把这样的东西包括在我的课上呢?

我想这样做:

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

2 回复 | 直到 13 年前

1

ideafountain 13 年前

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

转换/main_sandcastle.xslt content/shared_content.xml

2

0

galford13x 13 年前

由于这个例子包含泛型,文档没有正确解析,我不得不替换所有<具有 < 并且>具有 > 。

我用测试了文档这是文档示例中的一个测试,它运行得很好,但由于某种原因,它不能正确地使用我的真实代码。在用适当的转义序列替换标记之后,一切都正常工作。

另请注意,声称的{T}也没有正确发挥作用,因为它是逐字印刷的,而不是翻译成一般性陈述。尽管我希望 <code></code> 声明,我也希望 List<string> 声明也能正常工作。