.net XML文档注释包含sandcastle中的指令而不添加到帮助文件

时间:2012-03-01 04:07:06

标签: .net include sandcastle xml-documentation

有一个有趣的。我正在使用C#中的XML文档注释记录一个方法。我想使用该指令包含引用文件的所有内容。我正在记录一段接收格式化为xml文档的字符串的代码,我想在参数文档中包含XSD文件。

这很好用,因为Visual Studio生成的XML是我所期望的。这是XML的片段:

    /// <param name="xml">XML string - see Test.xsd <include file="XSD/Test.xsd" path="/*"/> After file include</param>

但是,当我使用Sandcastle从中生成帮助文件时,xsd文件的内容不会显示,但Sandcastle不会报告任何错误。我试图使用文件名作为帮助文件的相对位置,即

然后Visual Studio抱怨它无法找到该文件。我把它们放在两个地方,但仍然没有出现包含的文件。

有什么想法吗?

1 个答案:

答案 0 :(得分:0)

include标记在编译时处理,因此生成的XML文件应包含其所有引用的内容。因此,您必须将您的XSD文件夹相对于C#源文件,然后编译器将不会显示任何错误。在此之后,Sandcastle将能够从单个XML文档创建帮助文件。