2010-09-03 14 views
21

grails doc चलाकर बनाया गया दस्तावेज़ मेरी आंखों में पूरी तरह से संतोषजनक नहीं है। उदाहरण के लिए, नियंत्रकों में क्रियाएँ प्रलेखन में गुणों के रूप में दिखाई देती हैं, हालांकि मैं वास्तविक गुणों (स्ट्रिंग इत्यादि) से अलग-अलग कार्यों को अलग करने के लिए एक अतिरिक्त अनुभाग रखना चाहता हूं।Grails: Grails डॉक्टर के विकल्प?

वहाँ किसी भी उपकरण है कि JavaDoc की तरह टिप्पणी पर काम करते हैं और Grails परियोजनाओं के लिए बेहतर परिणाम उत्पन्न कर रहे हैं?

उत्तर

8

यह या तो होना चाहिए Grails अवगत (यानी समझता है कि नियंत्रकों में बंद वास्तव में कार्रवाई कर रहे हैं) या स्पष्ट टैगिंग की अनुमति देते हैं (उदाहरण के लिए एक @section Actions टिप्पणी पैरा एक वर्ग "कार्रवाई" कहा जाता है में दिखाती है) grails-new-doc परियोजना पर एक नजर डालें ।

1

"Grails Runtime डॉक्स" प्लगइन देखें (http://grails.org/plugin/grails-runtime-docs)। यह गतिशील विधियों समेत रनटाइम से ग्रोवी दस्तावेज उत्पन्न करेगा, जिसमें "डायनामिक विधि सारांश" & जेनरेट किए गए HTML दस्तावेज़ों में "डायनामिक विधि विवरण" शामिल होगा जो उनकी स्रोत जानकारी प्रदान करता है। यह अधिक Grails अवगत है और वर्गों को नियंत्रकों, कमांड, डोमेन, सेवाओं और टैग पुस्तकालयों में वर्गीकृत करता है। नोट: मैं एक grails डेवलपर हूँ और खुद को Grails के लिए इस ओपन-सोर्स प्लगइन का योगदान दिया। उम्मीद है यह आपको उपयोगी होगा।

+0

आप का खुलासा करना चाहिए कि लिंक एक दस्तावेज आप – Skuld

+0

@Skuld बनाया है: सुझाव के लिए धन्यवाद। मैंने अभी खुलासा के बारे में सीखा है और तदनुसार मेरा जवाब संपादित किया है। पृष्ठ प्लगइन का योगदान करने के लिए लेखक के लिए grails द्वारा बनाया गया है। धन्यवाद। –

+0

कोई चिंता नहीं, केवल एक सिर ऊपर है, अगर आप पोस्ट पर हैं और आपको खुलासा नहीं करते हैं तो संभावित रूप से स्पैम के रूप में फ़्लैग किया जा सकता है। :) – Skuld

1

ऐसा लगता है जैसे आप Grails का पुराना संस्करण चला रहे हैं।

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

आप अपग्रेड करने के बारे में चिंतित हैं, मैं 2008 के बाद से Grails का उपयोग कर रहे हैं और हमेशा उन्नयन जब नए संस्करणों बाहर आते हैं।

यह Grails उन्नत करने के लिए, किसी दस्तावेजी "परिवर्तन तोड़ने" पता करने के लिए कोड को अद्यतन, परीक्षण चलाने के लिए, और वापस लौटने अगर मैं कोई समस्या मिलती है एक दिन से भी लिया कभी नहीं किया है।

चूंकि अपग्रेड करना इतना आसान है, मैं हमेशा नवीनतम स्थिर रिलीज को बनाए रखने की कोशिश करता हूं।

जिस तरह से प्लगइन्स समस्याग्रस्त हो सकते हैं। आपको, या निश्चित रूप से, आपके द्वारा उपयोग किए जाने वाले किसी भी प्लगइन के लिए परीक्षण करना चाहिए। वास्तव में बेहतर प्लगइन में पहले से ही परीक्षण शामिल हैं, जिन्हें आप चला सकते हैं।

+0

बहुत बहुत धन्यवाद। कुछ हफ्ते पहले, हम पहले से ही grails के नवीनतम संस्करण में अपग्रेड कर चुके हैं, लेकिन जैसा कि आप देख सकते हैं, यह सवाल 2010 से है। वैसे भी, मैं नया grailsdoc एक कोशिश दे दूंगा। –