2013-04-22 9 views
16

एनोटेशन @param कैसे काम करता है?@param कार्य वास्तव में कैसे करता है - जावा

अगर मैं कुछ इस तरह था:

/* 
*@param testNumber; 
*/ 

int testNumber = 5; 
if (testNumber < 6) { 
    //Something 
} 

कैसे @param testNumber प्रभाव पड़ेगा? क्या यह testNumber को भी प्रभावित करता है?

धन्यवाद। अगर मैं इसे गलत इस्तेमाल करता हूं तो मुझे बताएं।

+2

'/ **' से शुरू होने वाले ब्लॉक और '* /' के साथ समाप्त होने वाले ब्लॉक केवल 'जावडोक' द्वारा संसाधित किए जाते हैं। जावा कंपाइलर द्वारा उन्हें 'टिप्पणियां' के रूप में माना जाता है। –

उत्तर

11

@param संख्या को प्रभावित नहीं करेगा। मुझे विश्वास है कि यह सिर्फ javadocs बनाने के लिए है।

अधिक जावाडोक पर: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

+1

यह सही है, जहां तक ​​मुझे पता है। आप '@param blahblah' डाल सकते हैं और यह जेडी को पैरामीटर 'blahblah' के लिए उत्पन्न करेगा। –

+0

परम विधि को प्रभावित नहीं करता है। यह आपको दिखाएगा कि विधि के विवरणों को देखने के दौरान आपको क्या चाहिए (दबाए जाने के बाद विधि पर होवर माउस।) आप पैरामीटर पर अधिक जानकारी प्रदान करने के लिए @param के बाद और भी जोड़ सकते हैं –

19

@param एक विशेष प्रारूप जावाडोक द्वारा प्रयोग किया जाता प्रलेखन उत्पन्न करने के लिए टिप्पणी है। इसका उपयोग पैरामीटर (या पैरामीटर) के विवरण को इंगित करने के लिए किया जाता है। वहाँ भी @return और @see वापसी मूल्यों और संबंधित जानकारी, क्रमशः का वर्णन किया जाता है:

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format

, है अन्य बातों के अलावा, इस:

/** 
* Returns an Image object that can then be painted on the screen. 
* The url argument must specify an absolute {@link URL}. The name 
* argument is a specifier that is relative to the url argument. 
* <p> 
* This method always returns immediately, whether or not the 
* image exists. When this applet attempts to draw the image on 
* the screen, the data will be loaded. The graphics primitives 
* that draw the image will incrementally paint on the screen. 
* 
* @param url an absolute URL giving the base location of the image 
* @param name the location of the image, relative to the url argument 
* @return  the image at the specified URL 
* @see   Image 
*/ 
public Image getImage(URL url, String name) { 
2

@param को प्रभावित नहीं करेगा testNumber.It एक Javadoc है टिप्पणी - यानी प्रलेखन उत्पन्न करने के लिए प्रयोग किया जाता है। आप कक्षा, फ़ील्ड, विधि, कन्स्ट्रक्टर या इंटरफ़ेस जैसे @param, @return से पहले Javadoc टिप्पणी तुरंत डाल सकते हैं। आम तौर पर '@' से शुरू होता है और लाइन पर पहली बात होनी चाहिए।

@param का उपयोग कर के लाभ है: - सरल जावा क्लासों जो गुण और कुछ कस्टम जावाडोक टैग शामिल बना कर आप उन वर्गों कोड पीढ़ी के लिए एक सरल मेटाडाटा विवरण के रूप में सेवा करने के लिए अनुमति देते हैं।

/* 
     *@param testNumber 
     *@return integer 
    */ 
    public int main testNumberIsValid(int testNumber){ 

     if (testNumber < 6) { 
      //Something 
     } 
    } 

जब भी अपने कोड में अगर आप testNumberIsValid विधि का पुन: उपयोग, आईडीई आप मापदंडों विधि स्वीकार करता है और दिखा देंगे वापसी विधि के प्रकार।

0

यह मूल रूप से एक टिप्पणी है। जैसा कि हम जानते हैं, उसी परियोजना पर काम करने वाले कई लोगों को कोड परिवर्तनों के बारे में ज्ञान होना चाहिए। हम पैरामीटर के बारे में कार्यक्रम में कुछ नोट्स बना रहे हैं।

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