如何记录XML Schema?

时间:2010-12-31 21:20:24

标签: xml documentation schema xsd

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

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

1 个答案:

答案 0 :(得分:11)

在我看来,使用 xsd:文档 xsd:annotation 专为此而设计。这样,XSD就是自我记录(很像源代码中的java文档),文档总是与XSD一起分发。查看here中的示例以及如何在XML编辑器中就地显示文档。alt text

如果您不想这样做,我建议您查看这篇文章How to convert xsd to human readable documentation?