为 C# 生成的 XML 文档的 XSD？ [关闭]

Posted 2023-02-21

【中文标题】为 C# 生成的 XML 文档的 XSD？ [关闭]

【英文标题】：XSD for XML documentation generated for C#? [closed]

【发布时间】：2011-03-12 11:03:18

【问题描述】：

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

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

谢谢。

【问题讨论】：

没有严格回答您的问题，但这里是 a recommended tag list 与使用示例的链接。注意：您可以在页面上选择适用的 Visual Studio 版本。

【参考方案1】：

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

【讨论】：

我知道这是一个旧答案，但我正在尝试查找有关成员元素名称属性格式的文档。我看到了正则表达式，但正在寻找有关如何解释它的文档。

【参考方案2】：

今天偶然发现了这个老问题。我在查看 Microsoft 的文档时没有看到这一点，也没有在查看我认为可能有兴趣开发这种模式的其他项目时看到这一点；即，Sandcastle 和（长期失效的）NDoc 项目的来源。

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

您可以编写虚拟源代码来练习每个 XML 文档注释标记，为其构建 XML 文档文件，然后使用 XSD.EXE。从中生成 XSD，并在处理完成后使用它来验证 XML 文档。但我认为这可能没有听起来那么简单。

此外，XML 文档 cmets 指的是类型和代码元素，并且模式无法捕捉到很多东西；例如，验证 <param> 标记的名称属性是否仍然引用 C# 源代码中的实际参数名称。编译器在构建时验证这些元素。但是，如果您对 XML 文档进行后处理，则需要一个自定义工具来引用原始 C# 源或生成的程序集来重新验证此类引用。