تنسيق نظام XSD لمراجعة الزملاء

قمت بتصميم نموذج بيانات يمثله نظام XSD. يوفر نموذج البيانات أيضًا الأنواع التي يتم استخدامها كمعلمات خدمة ويب في واصف WSDL.

أرغب في إرسال مخطط XSD واطلب من الأشخاص المشاركين استعراض النظراء لنموذج البيانات.

ما هي الأداة أو طريقة العرض التي تقترح استخدامها كأساس لمراجعات النظراء؟ يجب أن يكون نموذج البيانات قابلاً للقراءة للأشخاص غير المهرة ، على الأقل عندما يتعلق الأمر بالمعاني الدلالية للمعاملات

تعديل: </قوي>

أن تكون أكثر تحديدًا: بالطبع ، بناءًا ، يتم التحقق من صحة المخطط. في الواقع أنا أعمل حاليًا على رمز يعتمد على فئات JAXB التي تم إنشاؤها. هدفي هو

  1. لتجميد نموذج البيانات وبالتالي معلمات الإدخال
  2. للتأكد لا شيء ضاع أو نسي من الدلالي (بمعنى وجهة نظر تجارية ذات صلة.

تعديل 2

لقد كنت أفكر في الطريقة الأفضل لنشر نموذج حول. أفكر في شيء مثل JavaDoc لمخططات XSD. أي شخص يعرف ما إذا كان هناك شيء كهذا موجود؟ أساسا سوف يتم ذلك مع مجموعة من XSLTs ، أليس كذلك؟

10
وأضاف المؤلف f3lix, مصدر

5 إجابة

أعرف الأدوات التالية التي تنشئ وثائق من xml Schema files (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

بالنسبة إلى مخطط xml صغير ، ربما أقترح استخدام ورقة أنماط xs3p XSLT. لمزيد من المخطط المعقد ، أقترح استخدام xsddoc .

20
وأضاف

أقرب شيء إلى Javadoc لمخطط xml الذي رأيته هو تشغيل أداة Javadoc على المصدر الذي تم إنشاؤه من المخطط. يتطلب هذا أمرين: 1) أن مخططك يحتوي على عناصر توضيحية داخلية توثقه ، وأن 2) يستخدم مولد المصدر تلك التعليقات كجاكادوك.

0
وأضاف

أوصي باستخدام XSD للحصول على شيء ما. على وجه التحديد ، عرض بعض التطبيقات الفعلية ، مع أمثلة ككود حقيقي.

التطبيقات الفعلية هي ما يجعل مخططًا مثيرًا للاهتمام. لا يجب أن تكون الأمثلة كبيرة أو معقدة أو واقعية تمامًا. لديهم فقط لتجميع. سيحتاج الأشخاص الآخرون إلى نسخ نماذج الشفرات ولصقها.

هذه الأمثلة هي "hello world" المخطط. وهي بمثابة نوع من اختبار الوحدة للمخطط.

0
وأضاف

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

يمكنك إلقاء نظرة على مستند Innovasys! X . بالإضافة إلى إنشاء صفحة منظمة وموضوعة تلقائيًا لكل عنصر ، نوع بسيط ، نوع معقد ، مجموعة ومجموعة سمات ، سيؤدي أيضًا إلى إنشاء مخططات XSD مرتبطة (بما في ذلك التسلسل/الاختيار وما إلى ذلك) وجداول بنية تتضمن التعليقات التوضيحية من XSDs و تفهم العلاقات بين العناصر في المخططات الخاصة بك. الإخراج هو قالب يستند حتى تتمكن من تكييفه مع النمط والهيكل المفضل لديك. سوف يبني الإخراج إلى HTML جاهزة على شبكة الإنترنت أو ملفات المساعدة المترجمة.

فريد أيضاً يتضمن محرر WYSIWYG الذي يسمح لك بتأليف محتوى إضافي لتكملة الأشياء التي يتم إنشاؤها تلقائيًا والتعليقات التوضيحية من مصدر XSD - حتى تتمكن من توفير معلومات سياقية إضافية لمراجعة الزملاء. هناك أيضًا ميزة "ملحقات المنتدى" التي تتيح للأشخاص الذين يشاهدون المخرجات الناتجة تسجيل التعليقات والملاحظات التي يمكن مشاهدتها واتخاذ إجراءات مباشرة من داخل المستند! X.

0
وأضاف

كما يدعم مطور أكسجين أكسجين مفيد للغاية توليد الوثائق ، انظر http://www.oxygenxml.com/xml_schema_documentation.html (تجاري ، ولكن هناك نسخة تجريبية لمدة 30 يومًا تعمل بكامل طاقتها)

سأحاول ذلك الآن ، تحتاج إلى طريقة بسيطة لإنشاء مستند مع جميع أنواع وصف XSD: الوثائق المتاحة ووصف واجهة بسيطة ...

0
وأضاف