2009-08-26 9 views
7

मैं एक एपीआई के रूप में हमारे डेटाबेस पैकेज को पूरी तरह से दस्तावेज करने का प्रयास कर रहा हूं। हम जो चाहते हैं वह पीएल/एसक्यूएल के लिए जावाडॉक्स की तरह कुछ है। मैंने वहां कुछ टूल्स देखे हैं (pldoc, plsqldoc) लेकिन उन लोगों से जानना चाहते हैं जो उनका उपयोग करते हैं।पीएल/एसक्यूएल पैकेज इनलाइन दस्तावेज़ीकरण

उत्तर

6

मैंने प्लॉडोक का उपयोग किया है और इसे वास्तव में अच्छा लगता है। मैंने किसी अन्य उपकरण का उपयोग नहीं किया है, इसलिए इसकी तुलना नहीं की जा सकती है। मैंने पाया कि पीएलडीओसी ने मूल बातें अच्छी तरह से की थीं। मैं कुछ और उन्नत फीचर्स चाहता था इसलिए मैंने अपना खुद का टूल बनाया जो अधिक टैग के लिए पीएलडीओसी में एक्सटेंशन जोड़ता था। इसके अलावा मैं इसके साथ प्रलेखन नहीं करता हूं, मैं कुछ पीएलडीओसी टैग (जैसे @private) का उपयोग करके हमारे पैकेज हेडर भी उत्पन्न करता हूं।

मुझे सलाह है कि आप PlDoc को आजमाएं, फिर जो कुछ भी आपकी आवश्यकताओं को पूरा नहीं करता है उसे ट्विक करें। इसे स्थापित करने में इतना समय नहीं लगता है, इसलिए इसे आजमाने के लिए एक बड़ा समय निवेश नहीं है।

2

मैं कुछ वर्षों से NaturalDocs का उपयोग कर रहा हूं और इसे इंस्टॉल करना और उपयोग करना आसान पाया है। यह जावाडॉक्स की तरह काफी है और कई भाषाओं का समर्थन करता है हालांकि मैंने इसे केवल पीएल/एसक्यूएल के साथ उपयोग किया है। बहुत विन्यास योग्य हालांकि मुझे इसके साथ परेशान करने के लिए यह आवश्यक नहीं मिला है।

+0

मुझे शायद आपके उत्तर के बिना यह विशेष टूल नहीं मिला होगा। जबकि काफी पहुंचने योग्य, मुझे लगता है कि एक और कठोर रूप से संरचित समाधान हमारी टीम की जरूरत है। धन्यवाद! –

संबंधित मुद्दे