xml - 如何记录 XML 模式?

标签 xml documentation schema xsd

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

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

最佳答案

我认为最好的方法(经过 6 年的 xsd 和设计/编码系统到系统接口(interface)的经验)是使用 xsd:documentationxsd:annotation 专为此而设计。通过这种方式,XSD 是 self 记录的(很像源代码中的 java 文档)并且文档始终与 XSD 一起分发。查看 here 中的示例以及如何在 XML 编辑器中就地显示文档。 alt text

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

关于xml - 如何记录 XML 模式?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4572352/

相关文章:

postgresql - 如何使用 PostgreSQL 代码片段?

java - 如何在模式中正确声明扩展?

java - java中的XML解析: ignore tags as value

java - 如何在 StAX 中跟踪大文件的解析进度?

android - Android 菜单中的复选框选项不起作用

c++ - qpThreads 文档

java - 如何将 JDK 文档 jar 文件(包含 JDK 类(如 String 等)文档的文件)添加到 JDeveloper?

java - 获取 xml 中元素的值 - 始终返回 null

python - 使用 NumPyDoc 样式的 Napoleon Sphinx 扩展的类方法列表

基于 jquery 的 xml 编辑器,使用 xml 模式