सहकर्मी समीक्षा के लिए एक्सएसडी योजना स्वरूपण

मैंने एक डेटा मॉडल तैयार किया जिसे एक्सएसडी योजना द्वारा दर्शाया गया है। डेटा मॉडल उन प्रकारों को भी प्रदान करता है जिनका उपयोग डब्लूएसडीएल डिस्क्रिप्टर में वेब सेवा पैरामीटर के रूप में किया जा रहा है।

मैं एक्सएसडी योजना को चारों ओर भेजना चाहता हूं और डेटा मॉडल की समीक्षा करने के लिए शामिल लोगों से पूछना चाहता हूं।

सहकर्मी समीक्षा के आधार के रूप में उपयोग करने के लिए आप किस उपकरण या प्रस्तुति विधि का सुझाव देंगे? डेटा मॉडल को गैर-कुशल लोगों के लिए पठनीय होना चाहिए, कम से कम जब यह पैरामीटर के अर्थपूर्ण अर्थों की बात आती है

संपादित करें:

अधिक विशिष्ट होने के लिए: बेशक, वाक्य रचनात्मक रूप से, योजना मान्य है। दरअसल मैं पहले से ही कोड पर काम कर रहा हूं जो जेएक्सबी जेनरेटेड क्लास पर आधारित है। मेरा लक्ष्य है

  1. डेटा मॉडल को फ्रीज करने के लिए और इस प्रकार इनपुट पैरामीटर
  2. सुनिश्चित करने के लिए
  3. कुछ भी खो गया या भूल गया अर्थपूर्ण (के अर्थ में व्यापार-प्रासंगिक) दृष्टिकोण का बिंदु।

2 संपादित करें

मैं इस बारे में सोच रहा हूं कि आसपास के डाटामैडल को फैलाना शायद सबसे अच्छा होगा। मैं एक्सएसडी स्कीमा के लिए जावाडॉक की तरह कुछ सोच रहा हूं। किसी को पता है कि ऐसा कुछ मौजूद है? असल में यह एक्सएसएलटी के एक सेट के साथ किया जाएगा, है ना?

10
यह भी देखें:
जोड़ा लेखक f3lix, स्रोत

5 उत्तर

मैं निम्नलिखित टूल्स जानता हूं जो एक्सएमएल स्कीमा फाइलों (एक्सएसडी) से दस्तावेज उत्पन्न करते हैं:

  • 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

एक एक्सएमएल स्कीमा के लिए, मैं शायद xs3p XSLT स्टाइलशीट का उपयोग करने का सुझाव दूंगा। अधिक जटिल स्कीमा के लिए, मैं xsddoc का उपयोग करने का सुझाव देता हूं।

20
जोड़ा

मैंने देखा है कि एक एक्सएमएल स्कीमा के लिए जावाडोक की सबसे नज़दीकी चीज स्कीमा से उत्पन्न स्रोत पर जावाडोक उपकरण चला रही है। इसके लिए दो चीजों की आवश्यकता है: 1) कि आपके स्कीमा में आंतरिक एनोटेशन तत्व हैं जो इसे दस्तावेज करते हैं, और वह 2) आपका स्रोत जेनरेटर उन टिप्पणियों का उपयोग जावाडोक तत्वों के रूप में करता है।

0
जोड़ा

मैं कुछ के लिए एक्सएसडी का उपयोग कर अनुशंसा करता हूं। विशेष रूप से, वास्तविक कोड के रूप में उदाहरणों के साथ कुछ वास्तविक अनुप्रयोग दिखाएं।

वास्तविक अनुप्रयोग एक स्कीमा दिलचस्प बनाते हैं। उदाहरणों को बड़ा, परिष्कृत या पूरी तरह यथार्थवादी होना जरूरी नहीं है। उन्हें सिर्फ संकलन करना है। अन्य लोग कोड नमूने कॉपी और पेस्ट करना चाहते हैं।

ये उदाहरण स्कीमा की "हैलो वर्ल्ड" हैं। और वे स्कीमा के लिए एक प्रकार का यूनिट परीक्षण के रूप में कार्य करते हैं।

0
जोड़ा

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

आप Innovasys दस्तावेज़ पर एक नज़र डाल सकते हैं! एक्स । साथ ही प्रत्येक तत्व, सरल प्रकार, जटिल प्रकार, समूह और विशेषता समूह के लिए एक संरचित और लिंक किए गए पृष्ठ को स्वचालित रूप से उत्पन्न करने से यह लिंक किए गए एक्सएसडी आरेख (अनुक्रम/पसंद इत्यादि सहित) और संरचना सारणी भी उत्पन्न करेगा जिसमें आपके एक्सएसडी से एनोटेशन शामिल होंगे और अपने स्कीमा में तत्वों के बीच संबंधों को समझें। आउटपुट टेम्पलेट आधारित है ताकि आप इसे अपनी पसंदीदा शैली और संरचना में अनुकूलित कर सकें। यह वेब तैयार एचटीएमएल या संकलित सहायता फाइलों के लिए आउटपुट का निर्माण करेगा।

विशिष्ट रूप से इसमें एक WYSIWYG संपादक भी शामिल है जो आपको स्वचालित रूप से जेनरेट की गई सामग्री और एक्सएसडी स्रोत से एनोटेशन को पूरक करने के लिए अतिरिक्त सामग्री को लेखक की अनुमति देता है - ताकि आप अपने सहकर्मी समीक्षा के लिए अतिरिक्त प्रासंगिक जानकारी प्रदान कर सकें। एक सामुदायिक एक्सटेंशन सुविधा भी है जो उत्पन्न जनरेटिंग को टिप्पणियों और प्रतिक्रियाओं को रिकॉर्ड करने के लिए लोगों को देखने की अनुमति देती है और इसे सीधे दस्तावेज़ के भीतर से देखा और क्रियान्वित किया जा सकता है! एक्स।

0
जोड़ा

बहुत उपयोगी ऑक्सीजन एक्सएमएल डेवलपर भी प्रलेखन उत्पन्न करने का समर्थन करता है, देखें http://www.oxygenxml.com/xml_schema_documentation.html (वाणिज्यिक, लेकिन एक पूरी तरह कार्यात्मक 30 दिन का परीक्षण उपलब्ध है)

मैं इसे अभी आज़माउंगा, सभी प्रकारों और उपलब्ध xsd के साथ दस्तावेज़ उत्पन्न करने का एक आसान तरीका चाहिए: दस्तावेज़ीकरण विवरण एक साधारण इंटरफ़ेस विवरण के रूप में ...

0
जोड़ा