格式化 XSD 方案以供同行评审 [英] Formatting XSD scheme for peer review

查看:15
本文介绍了格式化 XSD 方案以供同行评审的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

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

I designed a data model which is represented by an XSD scheme. The data model also provides the types that are being used as web service parameters in a WSDL descriptor.

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

I would like to send the XSD scheme around and ask the people involved to peer review the data model.

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

What tool or presentation method would you suggest to be used as a basis for peer reviews? The data model should be readable for non-skilled people, at least when it comes to the semantic meanings of the parameters

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

To be more specific: Of course, syntactically, the scheme validates. Actually I'm already working on code which is based on JAXB generated classes. My goal is

  1. 冻结数据模型,从而输入参数
  2. 以确保没有任何东西丢失或忘记语义(意思是业务相关)的观点.

编辑 2

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

I've been thinking about how it probably would be best to spread a datamodel around. I'm thinking of something like a JavaDoc for XSD schemas. Anyone knows if something like that exists? Basically it would be done with a set of XSLTs, right?

推荐答案

我知道以下从 XML Schema 文件 (XSD) 生成文档的工具:

I know the following tools that generate documentation from XML Schema files (XSD):

  • xs3p
    • 从 XSD 生成单个 XHTML 的 XSLT 样式表
    • 免费/LGPL
    • 主要基于 XSLT
    • 类似 JavaDoc 的输出
    • 请参阅 xsddoc 示例
    • 改进的 xsddoc 商业版
    • 免费供个人/教育使用
    • 类似 JavaDoc 的输出
    • 商业
    • 类似 JavaDoc 的输出

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

    For small a XML schema, I would probably suggest using the xs3p XSLT stylesheet. For more a complex schema, I suggest using xsddoc.

    这篇关于格式化 XSD 方案以供同行评审的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆