为C#生成的XSD for XML文档?

时间:2010-07-06 17:59:56

标签: c# documentation xsd comments

有没有人知道某个XSD文件是否可用于验证使用/ doc选项编译C#项目时生成的XML文档?

我想在生成文件后手动修改该文件,我正在寻找一种简单的方法来确认我没有损坏文件的结构。

感谢。

2 个答案:

答案 0 :(得分:8)

我终于崩溃并写了一个:XSD for Xml Comments for .NET Documentation

答案 1 :(得分:2)

今天偶然发现了这个老问题。我没有看到微软的文档,也没看到我认为可能有兴趣开发这样一个模式的其他项目。即Sandcastle和(长期不复存在的)NDoc项目的来源。

如果没有退回尝试自己定义架构,我可以建议的一件事就是使用从XML生成XSD的众多工具之一。 Microsoft将XSD.EXE作为Visual Studio及其SDK的一部分。

您可以编写虚拟源来执行每个XML文档注释标记,为其构建XML文档文件,然后使用XSD.EXE。从中生成XSD,并在处理完成后使用它来验证XML文档。但我认为这可能不像听起来那么微不足道。

此外,XML文档注释引用了类型和代码元素,并且架构无法捕获许多内容;例如,验证<param>标记的name属性是否仍然引用C#源中的实际参数名称。编译器在构建时验证这些元素。但是,如果您对XML文档进行后处理,则需要一个自定义工具,该工具可以引用原始C#源或生成的程序集来重新验证此类引用。