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

Rhy*_*ick 7 c# documentation xsd comments

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

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

谢谢.

csh*_*net 8

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


And*_*own 2

今天偶然发现了这个老问题..我没有通过查看微软的文档看到这一点,也没有在查看我认为可能对开发这样的模式感兴趣的其他项目时看到这一点;即Sandcastle和(早已解散的)NDoc项目的来源。

除了尝试自己定义模式之外,我建议的一件事是使用从 XML 生成 XSD 的众多工具之一。Microsoft 将其XSD.EXE作为 Visual Studio 及其 SDK 的一部分。

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

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