ग्रहण के लिए GhostDoc समतुल्य (जावा)

Question

मैं विजुअल स्टूडियो में GhostDoc की स्वचालित टिप्पणी पीढ़ी का एक बड़ा प्रशंसक हूं, इसलिए एक प्लगइन की तलाश में हूं जो ग्रहण में मेरे जावा कोड के साथ एक ही काम करता है। कोई सिफारिशें?

Answer 1

यह मूल रूप से जावाडोक के बराबर है, जो शॉर्टकट के साथ ग्रहण में पैदा किया जा सकता है:

एएलटी + शिफ्ट + जम्मू

(जब आप जावा के भीतर हैं आप कार्य करते हैं के लिए javadoc जोड़ने की इच्छा है)

वहां से, यदि आप वास्तव में एक्सएमएल प्रारूप चाहते हैं, तो आप कोशिश कर सकते हैं और use a JELDoclet

Answer 2

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

Answer 3

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

मेरी राय में ग्रहण खत्म हो चुका है GhostDoc का सबसे बड़ा लाभ "तत्व टिप्पणी उत्पन्न करें" है कि यह एक बहुत तेज और विश्वसनीय तरीके से इस बनाने जोड़कर प्रलेखन टिप्पणी जोड़ना आरंभ करने के प्रोग्रामर को प्रोत्साहित करती है। प्रोग्रामर अनुमानित पाठ स्वीकार कर सकता है, (50 से 80% मामलों में उपयुक्त), या अधिक जटिल तरीकों के लिए इस पर विस्तार करें। कनिष्ठ प्रोग्रामर के लिए जो दस्तावेज टिप्पणियों का उपयोग कैसे किया जाता है, उससे परिचित नहीं है, यह सीखने की अवस्था को जल्दी से छोटा कर सकता है और अच्छे प्रोग्रामिंग प्रथाओं को प्रोत्साहित कर सकता है।

Answer 4

आप JAutodoc (http://jautodoc.sourceforge.net/)
जांच कर सकते हैं लेखक से:

JAutodoc स्वचालित रूप से जोड़ने के लिए एक जावाडोक ग्रहण प्लगइन है और अपने स्रोत कोड के लिए हेडर फाइल। यह वैकल्पिक रूप से प्रारंभिक टिप्पणियों को जेवाडोक के लिए Velocity टेम्पलेट्स का उपयोग करके और शीर्षलेखों का उपयोग करके तत्व नाम से उत्पन्न करता है।

यह एक के बाद एक मैं GhostDoc के सबसे करीब पाया है है।

Answer 5

जावाडोक मेरे दोस्त GhostDoc की तरह नहीं है। जावाडोक केवल संरचना बनाता है ताकि कोई स्क्रैच से दस्तावेज लिख सके। GhostDoc वास्तव में विधि/संपत्ति नाम के अनुसार जानकारी भरता है।

उदाहरण:

/// <summary> 
/// Gets the user from id. 
/// </summary> 
/// <param name="id">The id.</param> 
/// <returns></returns> 
private string GetUserFromId(string id); 

JAutoDoc निकटतम मैं अब तक मिल गया है है लेकिन यह GhostDoc के रूप में के रूप में जादुई नहीं है।