我有一个类,我想创建一个关于如何使用的简单示例。但是,当我在类声明中使用标记时,这个示例不会出现在Sand城堡输出中。它对对象的成员很好,但对类本身却不起作用。沙堡能处理这个吗?
我想要做的一个例子是。
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;}
}
发布于 2012-09-04 21:46:37
由于包含泛型的示例,文档没有被正确地解析,所以我不得不用<
和>替换所有<。
我通过在文档示例中使用这是一个测试来测试文档,它运行得很好,但出于某种原因,它没有正确地使用我的真正代码。在用适当的转义序列替换标记后,一切都正常工作。
还请注意,声称的{T}没有正确工作,因为它是逐字打印的,而不是翻译成泛型语句。虽然我希望在<code></code>
语句中这样做,但我也希望List<string>
声明也能正常工作。
发布于 2012-09-12 17:10:20
对于沙堡,可以通过使用自己的标记转换定义修改main_sandcastle.xslt文件来创建自定义标记。您感兴趣的文件有:
转换/main_sandCastle.xslt内容/shared_content.xml
https://stackoverflow.com/questions/12271295
复制相似问题