为同行评审格式化XSD方案

11

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

我想传递XSD方案并请有关人员进行同行评审数据模型。

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

编辑:

更加具体地说:当然,从句法上讲,该方案是有效的。实际上,我已经在基于JAXB生成的类的代码上工作了。我的目标是

  1. 冻结数据模型,从而固定输入参数;
  2. 确保从语义(即与业务相关的含义)角度来看没有丢失或遗漏任何内容。

编辑2:

我一直在思考最好如何传播数据模型。我正在考虑类似于XSD模式的JavaDoc的东西是否存在?基本上,它将使用一组XSLT完成,对吗?


请参见:https://dev59.com/p3VC5IYBdhLWcg3wnCf6 - f3lix
5个回答

21
我知道以下几种工具可以从XML Schema文件(XSD)生成文档:
  • xs3p
    • XSLT样式表,可从XSD生成单个XHTML
  • xsddoc
    • 免费/LGPL授权
    • 主要基于XSLT
    • 类似于JavaDoc的输出
    • 请参阅xsddoc示例
  • xnsdoc
    • xsddoc的改进商业版本
    • 个人/教育用途免费
    • 类似于JavaDoc的输出
  • XSDdoc 2.0
    • 商业授权
    • 类似于JavaDoc的输出
对于小型XML模式,我可能会建议使用xs3p XSLT样式表。对于更复杂的模式,我建议使用xsddoc

0
我见过的与XML模式最接近Javadoc的东西是在从模式生成的源代码上运行Javadoc工具。这需要两个条件:1)您的模式具有记录其信息的内部注释元素,2)您的源代码生成器使用这些注释作为Javadoc元素。

0

我建议在某些方面使用XSD。具体来说,展示一些实际应用程序,例如真实的代码示例。

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

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


0

**声明:我是Innovasys的员工,下面提到的文档工具的生产商。

你可以看一下Innovasys Document! X。它不仅可以自动生成每个元素、简单类型、复杂类型、组和属性组的结构化和链接页面,还会生成链接的XSD图表(包括序列/选择等)和结构表,其中包括来自您的XSD的注释,并理解模式中元素之间的关系。输出是基于模板的,因此您可以将其适应为您喜欢的样式和结构。它将构建输出到Web准备好的HTML或已编译的帮助文件。

独特的是,它还包括一个所见即所得的编辑器,允许您编写额外的内容以补充自动生成的内容和来自XSD源的注释,因此您可以为同行评审提供额外的上下文信息。还有一个社区扩展功能,允许查看生成的输出的人记录评论和反馈,并可以直接从Document! X中查看和处理。


0
非常有用的Oxygen XML开发人员还支持生成文档,详情请参见http://www.oxygenxml.com/xml_schema_documentation.html(商业软件,但提供完全功能的30天试用版)。
我现在会尝试它,需要一种简单的方法来生成一个包含所有类型和可用xsd:documentation描述的文档,作为一个简单的接口描述...

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接