Formatarea schemei XSD pentru o evaluare colegială

Am proiectat un model de date care este reprezentat de o schemă XSD. Modelul de date oferă, de asemenea, tipurile care sunt utilizate ca parametri ai serviciului web într-un descriptor WSDL.

Aș dori să trimit schema XSD în jur și să întreb oamenii implicați să examineze modelul de date.

Ce metodă sau metodă de prezentare ați sugera a fi utilizată ca bază pentru evaluările inter pares? Modelul de date ar trebui să fie lizibil pentru persoanele necalificate, cel puțin atunci când vine vorba de semnificațiile semantice ale parametrilor

Editare:

Pentru a fi mai specific: Desigur, în mod sintactic, schema validează. De fapt, lucrez deja la un cod care se bazează pe clase generate de JAXB. Scopul meu este

  1. pentru a îngheța modelul de date și astfel parametrii de intrare
  2. pentru a vă asigura nimic nu sa pierdut sau uitat de la a semantic (în sensul relevante pentru afaceri).

Editați 2

M-am gândit cum ar fi cel mai bine să răspândim un datamodel în jur. Mă gândesc la ceva asemănător unei scheme JavaDoc pentru XSD. Oricine știe dacă există așa ceva? Practic, ar fi făcut cu un set de XSLT-uri, nu?

10
adăugat autor f3lix, sursa

5 răspunsuri

Știu următoarele instrumente care generează documentația din fișiere xml Schema (XSD):

  • xs3p
    • XSLT stylesheet that generates single XHTML from XSD
  • xsddoc
  • xnsdoc
    • improved commercial version of xsddoc
    • free for personal/educational use
    • JavaDoc like output
  • XSDdoc 2.0
    • commercial
    • JavaDoc like output

Pentru schema xml mică, aș sugera probabil utilizarea foii de stiluri XSLT xs3p XSLT. Pentru o schemă mai complexă, vă sugerăm să utilizați xsddoc .

20
adăugat

Cel mai apropiat lucru pentru Javadoc pentru schema xml pe care am văzut-o este executarea instrumentului Javadoc pe sursa generată de schemă. Acest lucru necesită două lucruri: 1) faptul că schema dvs. are elemente de adnotare interne care o documentează și că 2) generatorul sursă utilizează aceste adnotări ca elemente Javadoc.

0
adăugat

Vă recomandăm să utilizați XSD pentru ceva. Mai specific, arătați câteva aplicații reale, cu exemple drept cod real.

Aplicațiile actuale fac ceea ce face o schemă interesantă. Exemplele nu trebuie să fie mari, sofisticate sau complet realiste. Trebuie doar să compileze. Alți oameni vor dori să copieze și să lipsească mostrele de cod.

Aceste exemple sunt "lumea bună" a schemei. Și acționează ca un fel de test de unitate pentru schemă.

0
adăugat

** Disclosure : I work for Innovasys, the producer of the documentation tool mentioned below *

Ai putea să arunci o privire la Document Innovasys! X . Pe lângă generarea automată a unei pagini structurate și conectate pentru fiecare element, tip simplu, tip complex, grup și grup de atribute va genera, de asemenea, diagrame XSD (inclusiv secvențe/alegeri etc.) și tabele structurale care includ adnotările din XSD-urile dvs. și înțelegeți relațiile dintre elementele din schemele dvs. Ieșirea este bazată pe șabloane, astfel încât să o puteți adapta stilului și structurii preferate. Acesta va construi ieșire pentru html web-ready sau fișiere de ajutor compilate.

În mod unic, acesta include și un editor WYSIWYG care vă permite să creați conținut suplimentar pentru a completa materialele generate automat și adnotările din sursa XSD - astfel încât să puteți furniza informații suplimentare contextuale pentru evaluarea dvs. colegială. Există, de asemenea, o caracteristică a extensiilor comunitare, care permite utilizatorilor să vadă rezultatul generat pentru a înregistra comentarii și feedback și care pot fi vizualizate și acționate direct din cadrul documentului! X.

0
adăugat

Dezvoltatorul foarte util de oxigen xml susține, de asemenea, generarea de documentație, vezi http://www.oxygenxml.com/xml_schema_documentation.html (comercial, dar este disponibil un trial complet de 30 de zile)

O să încerc acum, am nevoie de o modalitate simplă de a genera un document cu toate tipurile și disponibil xsd: descrierea documentației ca o descriere a interfeței simple ...

0
adăugat