Форматирование схемы XSD для рецензирования - PullRequest
Новая
       9

Форматирование схемы XSD для рецензирования

10 голосов
/ 14 октября 2008

Я разработал модель данных, которая представлена ​​схемой XSD. Модель данных также предоставляет типы, которые используются в качестве параметров веб-службы в дескрипторе WSDL.

Я хотел бы разослать схему XSD и попросить вовлеченных людей проанализировать модель данных.

Какой инструмент или метод презентации вы бы предложили использовать в качестве основы для рецензирования? Модель данных должна быть удобочитаемой для неопытных людей, по крайней мере, когда речь идет о семантическом значении параметров

Edit:

Точнее, синтаксически схема проверяется. На самом деле я уже работаю над кодом, который основан на классах, сгенерированных JAXB. Моя цель

  1. чтобы заморозить модель данных и таким образом входные параметры
  2. чтобы убедиться ничто не потеряно или забыто семантический (в смысле с точки зрения бизнеса).

Редактировать 2

Я думал о том, как, вероятно, было бы лучше распространить модель данных вокруг. Я думаю о чем-то вроде JavaDoc для схем XSD. Кто-нибудь знает, существует ли что-то подобное? В основном это будет сделано с набором XSLT, верно?

Ответы [ 5 ]

20 голосов
/ 10 февраля 2009

Мне известны следующие инструменты, которые генерируют документацию из файлов XML Schema (XSD):

  • xs3p
    • Таблица стилей XSLT, которая генерирует один XHTML из XSD
  • xsddoc
    • бесплатно / LGPL
    • в основном на основе XSLT
    • JavaDoc как вывод
    • см. примеры xsddoc
  • xnsdoc
    • улучшенная коммерческая версия xsddoc
    • бесплатно для личного / учебного использования
    • JavaDoc как вывод
  • XSDdoc 2.0
    • коммерческая
    • JavaDoc как вывод

Для небольших XML-схем я бы, вероятно, предложил использовать таблицу стилей XSLT xs3p . Для более сложной схемы я предлагаю использовать xsddoc .

0 голосов
/ 29 марта 2012

Очень полезный разработчик Oxygen XML также поддерживает генерацию документации, см. http://www.oxygenxml.com/xml_schema_documentation.html (коммерческий, но есть полнофункциональная 30-дневная пробная версия)

Я попробую сейчас, нужен простой способ создания документа со всеми типами и доступным описанием xsd: документации в виде простого описания интерфейса ...

0 голосов
/ 11 августа 2011

** Раскрытие информации: я работаю на Innovasys, производителя инструмента документации, упомянутого ниже *

Вы можете взглянуть на Документ Innovasys! X . Помимо автоматической генерации структурированной и связанной страницы для каждого элемента, простого типа, сложного типа, группы и группы атрибутов, она также будет генерировать связанные диаграммы XSD (включая последовательности / выбор и т. Д.) И таблицы структуры, которые включают аннотации из ваших XSD и понять отношения между элементами в ваших схемах. Выходные данные основаны на шаблонах, так что вы можете адаптировать их к предпочитаемому стилю и структуре. Он будет выводить выходные данные в готовый HTML-файл или скомпилированные файлы справки.

Уникально, он также включает в себя WYSIWYG-редактор, который позволяет вам создавать дополнительный контент для дополнения автоматически сгенерированного материала и аннотаций из источника XSD - так что вы можете предоставить дополнительную контекстную информацию для вашей экспертной оценки. Существует также функция «Расширения сообщества», которая позволяет людям, просматривающим сгенерированный вывод, записывать комментарии и отзывы, которые можно просматривать и изменять непосредственно из Документа! X.

0 голосов
/ 23 января 2009

Ближайшая вещь к Javadoc для схемы XML, которую я видел, это запуск инструмента Javadoc для источника, сгенерированного из схемы. Это требует двух вещей: 1) что ваша схема имеет внутренние элементы аннотации, документирующие ее, и что 2) ваш исходный генератор использует эти аннотации в качестве элементов Javadoc.

0 голосов
/ 14 октября 2008

Я рекомендую , используя XSD для чего-то. В частности, показать некоторые реальные приложения, с примерами в качестве реального кода.

Актуальные приложения - вот что делает схему интересной. Примеры не должны быть большими, сложными или полностью реалистичными. Они просто должны скомпилировать. Другие люди захотят скопировать и вставить примеры кода.

Эти примеры являются "привет миром" схемы. И они действуют как своего рода модульный тест для схемы.

...