格式化 XSD 方案以供同行评审

Posted 2023-02-14

【中文标题】格式化 XSD 方案以供同行评审

【英文标题】：Formatting XSD scheme for peer review

【发布时间】：2010-09-17 03:40:58

【问题描述】：

我设计了一个由 XSD 方案表示的数据模型。 数据模型还提供了在 WSDL 描述符中用作 Web 服务参数的类型。

我想发送 XSD 方案并请相关人员对数据模型进行同行评审。

您建议使用什么工具或演示方法作为同行评审的基础？数据模型对于非技术人员来说应该是可读的，至少在涉及到参数的语义含义时

编辑：

更具体地说：当然，从句法上讲，该方案是有效的。实际上，我已经在研究基于 JAXB 生成的类的代码。我的目标是

冻结数据模型，从而 输入参数 确保 没有任何东西丢失或忘记 语义（意思是 业务相关）的观点。

编辑 2

我一直在考虑如何最好地传播数据模型。我正在考虑用于 XSD 模式的 JavaDoc 之类的东西。任何人都知道是否存在类似的东西？基本上它可以通过一组 XSLT 来完成，对吧？

【问题讨论】：

另见：***.com/questions/237938/…

【参考方案1】：

** 披露：我为 Innovasys 工作，下面提到的文档工具的生产商 *

您可以查看Innovasys Document! X。除了为每个元素、简单类型、复杂类型、组和属性组自动生成结构化和链接的页面外，它还将生成链接的 XSD 图（包括序列/选择等）和结构表，其中包括来自 XSD 的注释和理解架构中元素之间的关系。输出是基于模板的，因此您可以将其调整为您喜欢的样式和结构。它将构建输出到网络就绪的 html 或编译的帮助文件。

独特地，它还包括一个所见即所得的编辑器，允许您创作额外的内容来补充自动生成的内容和来自 XSD 源的注释 - 这样您就可以为同行评审提供额外的上下文信息。还有一个社区扩展功能，允许人们查看生成的输出以记录 cmets 和反馈，并且可以直接从 Document 中查看和操作！十。

【参考方案2】：

非常有用的 Oxygen XML 开发人员还支持生成文档，请参阅 http://www.oxygenxml.com/xml_schema_documentation.html （商业，但提供功能齐全的 30 天试用版）

我现在试试，需要一种简单的方法来生成一个包含所有类型和可用 xsd:documentation 描述的文档作为一个简单的接口描述......

【参考方案3】：

我知道以下从 XML 架构文件 (XSD) 生成文档的工具：

xs3p 从 XSD 生成单个 XHTML 的 XSLT 样式表 xsddoc 免费/LGPL 主要基于 XSLT 类似 JavaDoc 的输出 见xsddoc examples xnsdoc 改进的 xsddoc 商业版 免费供个人/教育使用 类似 JavaDoc 的输出 XSDdoc 2.0 商业 类似 JavaDoc 的输出

对于小型 XML 模式，我可能会建议使用 xs3p XSLT 样式表。对于更复杂的架构，我建议使用xsddoc。

【参考方案4】：

我见过的最接近 Javadoc 的 XML 模式是在从模式生成的源代码上运行 Javadoc 工具。这需要两件事：1）您的架构具有记录它的内部注释元素，以及 2）您的源生成器将这些注释用作 Javadoc 元素。

【参考方案5】：

我建议使用 XSD 做一些事情。具体来说，展示一些实际应用，并以实际代码的形式举例。

实际应用程序使模式变得有趣。这些示例不必很大、复杂或完全现实。他们只需要编译。其他人会想要复制和粘贴代码示例。

这些示例是架构的“hello world”。它们充当模式的一种单元测试。