Как преобразовать xsd в человекочитаемую документацию? [закрытый]
У нас есть базирующиеся интерфейсы нескольких XML, который вполне хорошо документируется в схемы XSD. Интерфейсы теперь будут общедоступными, и мы хотели бы создать справочную документацию для них.
Существует ли инструмент, который может автоматически преобразовать файлы XSD еще в некоторый читаемый формат?
6 ответов
кислород имеет очень хороший инструмент документации схемы XSD , который допускает легкую настройку через опции и дополнительные файлы CSS.
я не использовал его прежде, но , FlexDoc/XML является инструментом документации XML с компонентом документации XSD, названным XSDDoc, который выглядит интересным.
, Конечно, как указано в на других ответов, XSD является просто XML-файлом, таким образом, пользовательский XSLT мог быть записан для генерации любого вывода документации, Вам нравится.
xs3p мог бы сделать то, что Вы хотите (см. также их страница SourceForce).
Я генерировал документацию в прошлом использовании инструмента, который я нашел на Freshmeat.net названный xsddoc. Ища его сейчас (для получения прямой ссылки) я вижу, что это было заменено ее разработчиками с инструментом, названным xnsdoc. Более новый свободен для использования проектами с открытым исходным кодом, но если Вы используете это для коммерческого продукта, Вам, вероятно, придется лицензировать его. Если последняя версия, выпущенная под "xsddoc" баннером, удовлетворяет Вашим целям, то можно просто использовать тот.
документация, которую это производит, имеет стиль Javadoc и допускает определенную степень управления в таблице стилей, и т.д.
Это, не должен быть к трудно для преобразования его (или запись заранее) к формат DocBook .
Разногласия довольно хороши, что Вы не хотите использовать универсальный инструмент для документирования Вашей схемы. Инструменты документации схемы (я являюсь самым знакомым с тем в Шпионе XML), разработаны для создания схем читаемыми. Из Вашего описания это кажется, что это не действительно, что Вы хотите; то, что Вы хотите, должно использовать информацию в Вашей схеме к как основание документации программного обеспечения.
, Когда я должен был сделать это, подход, я взял, должен был разработать HTML, который смотрел способ, которым мне была нужна документация, чтобы посмотреть, и затем выяснить, какую информацию в схеме я должен буду захватить для заполнения его. Используя это как шаблон, это довольно просто для получения по запросу в релевантной информации из схемы с помощью XSLT.