如何记录XML Schema？

Question

我为我编写的应用程序开发了一个XML模式.现在我想记录最终用户的有效结构,但是我无法想出任何自然的方法来做到这一点.我见过像xs3p这样的东西,它实际上将xsd架构转换为HTML表示,但这对我来说看起来不是很好的文档; 用户不需要知道关于模式的任何信息,以了解他可以做什么.

任何想法如何记录这个？任何程序/编辑/图形解决方案或我可以构建的概念？

Answer 1

在我看来,最好的方法(经过6年的xsd和设计/编码系统到系统接口的经验)是使用专为此设计的xsd:documentation和xsd:annotation.这样,XSD就是自我记录(很像源代码中的java文档),文档总是与XSD一起分发.查看此处的示例以及如何在XML编辑器中就地显示文档.

如果您不想这样做,那么我建议您查看这篇文章如何将xsd转换为人类可读文档？