2010-06-07 2 views
7

मैं ग्रहण में कोड दस्तावेज कर रहा हूं और/** के बाद जावाडोक टेम्पलेट डालने के लिए बहुत कुछ दर्ज कर रहा हूं। हालांकि यह हमेशा किसी कारण से काम नहीं करता है, यह टिप्पणियां लिखने के लिए टेम्पलेट तैयार करेगा लेकिन यह स्वचालित रूप से @param और @return टेक्स्ट को सम्मिलित नहीं करेगा। अगर मैं एक ही कक्षा को एक ही कक्षा में कॉपी करता हूं तो यह पूर्ण टेम्पलेट डालेगा।क्यों/** [newline] हमेशा javadoc टेम्पलेट को सम्मिलित नहीं करता है जिसमें @param और @clurn में ग्रहण शामिल है?

अगर कोई मुझे बता सकता है कि यह कुछ स्थितियों में ऐसा क्यों नहीं करेगा तो यह एक बड़ी मदद होगी।

उत्तर

7

जहां तक ​​मुझे पता है कि यह आमतौर पर तब होता है जब ग्रहण निश्चित रूप से नहीं जानता कि आप किस विधि को दस्तावेज़ करना चाहते हैं।

विधि/कक्षा इत्यादि का चयन करने के लिए एक और विश्वसनीय तरीका होगा, जिसे आप जावाडोक बनाना चाहते हैं और ALT + SHIFT + J दबाएं या कक्षा की रूपरेखा में विधि पर राइट क्लिक करें और स्रोत -> तत्व टिप्पणी जेनरेट करें ।

+1

इस शॉर्टकट को मारने से मुझे इस इंटरफ़ेस पर इंगित किया जाएगा कि यह वर्ग लागू होता है (यानी यह सम्मिलित करता है (यानी जावा-एडवाक) और फिर @See package.class # विधि (पैरा) के साथ एक पंक्ति, मुझे लगता है कि यह जावाडोक को पसंद नहीं है एक वर्ग में जोड़ा गया है जो एक इंटरफ़ेस लागू करता है। तो अगर किसी कारण से मैं इंटरफ़ेस के कार्यान्वयन को दस्तावेज करना चाहता हूं, तो मुझे लगता है कि मुझे इसे मैन्युअल रूप से करना होगा। मुझे एहसास है कि दस्तावेज़ीकरण तक पहुंचने का सबसे अच्छा तरीका नहीं हो सकता है लेकिन मैं बस सोच रहा था कि यह क्यों काम नहीं कर रहा था। धन्यवाद! –

+0

वैसे इंटरफ़ेस द्वारा वर्णित विधियों का पूरा बिंदु यह है कि इंटरफ़ेस में पहले से ही आवश्यक दस्तावेज शामिल हैं (और कार्यान्वयन विधियों को किसी भी चीज़ से अलग व्यवहार नहीं करना चाहिए इंटरफ़ेस निर्दिष्ट करता है)। मैं javadoc क्लास हेडर में अतिरिक्त जानकारी डालूंगा। – Daff

+0

मुझे बस उस वर्ग में एक और उदाहरण मिला जो कुछ भी विस्तार या कार्यान्वित नहीं कर रहा है। कोई विचार नहीं कि यह यहां/** के साथ क्यों काम नहीं करता है लेकिन alt-shift-j सही ढंग से javadoc टेम्पलेट डालें। –

1

यह हमेशा मेरे लिए काम करता है, बिना किसी विधि के ऊपर एक टिप्पणी है जिसके लिए मैं प्रलेखन जोड़ने की कोशिश कर रहा हूं।

public class Test { 
    // Declare some fields. Bla bla bla. 

    // ~ Constructors 

    public Test() { // <-- If I insert /** above this line it fails to work 
    } 
} 

मेरे ठीक अस्थायी रूप से एक चर कि टिप्पणियों से मेरी विधि अलग करती है तो ग्रहण पहचानता है कि मैं क्या कर रहा हूँ घोषित करने के लिए आमतौर पर है: यहाँ कुछ कोड और एक गैर-दस्तावेजी विधि का एक उदाहरण है, जहां यह काम नहीं करेगा। ..

public class Test { 
    // Declare some fields. Bla bla bla. 

    // ~ Constructors 
    int i; 
    public Test() { // <-- If I insert /** above this line it works. Then discard the temp var. 
    } 
} 
0

यह पिछले निर्माण, मंगल के साथ कभी-कभी मेरे साथ हो रहा शुरू कर दिया। ग्रहण को पुनरारंभ करना इसे ठीक करता है। ऐसा लगता है कि इस तरह यादृच्छिक समस्याओं से बचने के लिए मुझे हर दिन एक्लिप्स को फिर से शुरू करने की आवश्यकता है।