Форматирование схемы XSD для рецензирования
Я разработал модель данных, которая представлена схемой XSD. Модель данных также предоставляет типы, которые используются в качестве параметров веб-службы в дескрипторе WSDL.
Я хотел бы разослать схему XSD и попросить вовлеченных людей провести рецензирование модели данных.
Какой инструмент или метод презентации вы бы предложили использовать в качестве основы для экспертной оценки? Модель данных должна быть удобочитаемой для неопытных людей, по крайней мере, когда речь идет о семантическом значении параметров
Редактировать:
Чтобы быть более конкретным: конечно, синтаксически, схема проверяется. На самом деле я уже работаю над кодом, который основан на классах, сгенерированных JAXB. Моя цель
- заморозить модель данных и, следовательно, входные параметры
- чтобы убедиться, что ничто не потеряно или забыто с семантической (в значении бизнес-релевантной) точки зрения.
Редактировать 2
Я думал о том, как, вероятно, было бы лучше распространить модель данных вокруг. Я думаю о чем-то вроде JavaDoc для схем XSD. Кто-нибудь знает, существует ли что-то подобное? В основном это будет сделано с набором XSLT, верно?
5 ответов
Я знаю следующие инструменты, которые генерируют документацию из файлов XML Schema (XSD):
- xs3p
- Таблица стилей XSLT, которая генерирует один XHTML из XSD
- xsddoc
- бесплатно / LGPL
- в основном на основе XSLT
- JavaDoc как вывод
- посмотрите примеры xsddoc
- xnsdoc
- улучшенная коммерческая версия xsddoc
- бесплатно для личного / образовательного использования
- JavaDoc как вывод
- XSDdoc 2.0
- коммерческая
- JavaDoc как вывод
Для небольших XML-схем я бы, вероятно, предложил использовать таблицу стилей xs3p XSLT. Для более сложной схемы я предлагаю использовать xsddoc.
Самая близкая вещь к Javadoc для схемы XML, которую я видел, это запуск инструмента Javadoc для источника, сгенерированного из схемы. Это требует двух вещей: 1) что ваша схема имеет внутренние элементы аннотации, документирующие ее, и что 2) ваш исходный генератор использует эти аннотации в качестве элементов Javadoc.
Я рекомендую использовать XSD для чего-то. В частности, показать некоторые реальные приложения, с примерами в качестве реального кода.
Актуальные приложения - вот что делает схему интересной. Примеры не должны быть большими, сложными или полностью реалистичными. Они просто должны скомпилировать. Другие люди захотят скопировать и вставить примеры кода.
Эти примеры являются "привет миром" схемы. И они действуют как своего рода модульный тест для схемы.
** Раскрытие информации: я работаю на Innovasys, производителя инструмента документации, упомянутого ниже *
Вы можете взглянуть на документ Innovasys! Х. Помимо автоматической генерации структурированной и связанной страницы для каждого элемента, простого типа, сложного типа, группы и группы атрибутов, она также будет генерировать связанные диаграммы XSD (включая последовательности / выбор и т. Д.) И таблицы структуры, которые включают аннотации из ваших XSD и понять взаимосвязи между элементами в ваших схемах. Вывод основан на шаблонах, так что вы можете адаптировать его к вашему предпочтительному стилю и структуре. Он создаст вывод в готовый HTML или скомпилированные файлы справки.
Кроме того, он включает в себя редактор WYSIWYG, который позволяет вам создавать дополнительный контент, дополняющий автоматически сгенерированные материалы и аннотации из источника XSD, чтобы вы могли предоставить дополнительную контекстную информацию для вашей экспертной оценки. Существует также функция "Расширения сообщества", которая позволяет людям, просматривающим сгенерированный вывод, записывать комментарии и отзывы, которые можно просматривать и изменять непосредственно из Документа! ИКС.
Очень полезный разработчик Oxygen XML также поддерживает создание документации, см. http://www.oxygenxml.com/xml_schema_documentation.html(коммерческий, но есть полнофункциональная 30-дневная пробная версия)
Я попробую это сейчас, мне нужен простой способ создания документа со всеми типами и доступным описанием xsd: документации в виде простого описания интерфейса...