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

时间:2008-10-14 17:17:46

标签: xsd datamodel review

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

我想发送XSD计划,并要求相关人员对数据模型进行同行评审。

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

修改

更具体一点:当然,从语法上讲,该方案是有效的。实际上我已经在处理基于JAXB生成的类的代码了。我的目标是

  1. 冻结数据模型,从而 输入参数
  2. 确保 什么都没有丢失或被遗忘 语义(意义上的) 与商业相关的观点。
  3. 修改2

    我一直在考虑如何最好地传播数据模型。我正在考虑像JavaDoc for XSD架构。谁知道这样的东西是否存在?基本上它可以用一组XSLT完成,对吧?

5 个答案:

答案 0 :(得分:20)

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

  • xs3p
    • 从XSD生成单个XHTML的XSLT样式表
  • xsddoc
    • free / LGPL
    • 主要基于XSLT
    • JavaDoc like output
    • 请参阅xsddoc examples
  • xnsdoc
    • 改进了xsddoc的商业版本
    • 免费供个人/教育使用
    • JavaDoc like output
  • XSDdoc 2.0
    • 商业
    • JavaDoc like output

对于小型XML架构,我建议使用 xs3p XSLT样式表。对于更复杂的架构,我建议使用xsddoc

答案 1 :(得分:0)

我建议使用 XSD。具体来说,显示一些实际应用程序,示例为实际代码。

实际应用程序使架构变得有趣。这些例子不一定要大,复杂或完全现实。他们只需要编译。其他人会想要复制和粘贴代码示例。

这些示例是架构的“hello world”。它们可以作为模式的一种单元测试。

答案 2 :(得分:0)

我见过的最接近Javadoc的XML模式是在从模式生成的源上运行Javadoc工具。这需要两件事:1)您的模式具有记录它的内部注释元素,并且2)您的源生成器将这些注释用作Javadoc元素。

答案 3 :(得分:0)

**披露:我为Innovasys工作,下面提到的文档工具的制作人 *

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

独特地,它还包括一个WYSIWYG编辑器,允许您创作其他内容以补充自动生成的内容和来自XSD源的注释 - 因此您可以为同行评审提供其他上下文信息。还有一个社区扩展功能,允许人们查看生成的输出以记录评论和反馈,并且可以直接从文档中查看和操作! X.

答案 4 :(得分:0)

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

我现在就试试看,需要一种简单的方法来生成一个包含所有类型和可用xsd的文档:文档描述作为一个简单的界面描述......