2010-12-07 18 views
8

तो, की सुविधा देता है कहते हैं कि मैं एक विधि है कि इतनी तरह एक एनोटेशन शामिल है:विधि टिप्पणियां और टिप्पणियां ... प्रत्येक को कहां जाना चाहिए?

@Override 
public void bar(String x) 

अगर मैं कोड के इस स्निपेट, जो पसंदीदा तरीका है करने के लिए जावाडोक टिप्पणियां जोड़ने के लिए कर रहे थे?

कोई एक:

/** 
* @param x A string lol 
*/ 
@Override 
public void bar(String x) 

या:

@Override 
/** 
* @param x A string lol 
*/ 
public void bar(String x) 

उत्तर

15

पहले एक। एनोटेशन विधि पर लागू होता है, टिप्पणी नहीं। यह भी है कि अधिकांश आईडीई क्या करेंगे, वैसे भी सबसे आम है।

+0

धन्यवाद ब्रो - यह मदद करता है :) आम तौर पर लोग आलसी होते हैं और टिप्पणियां जोड़ने के कारणों की तलाश नहीं करते हैं, इस प्रकार का भ्रम कभी-कभी कारण होता है। वकील को डालने का एक तरीका होना बहुत अच्छा है। – Bohdan

2

व्यक्तिगत रूप से, मैं पूर्व (यानी एनोटेशन "विधि हस्ताक्षर स्पर्श" पसंद करता हूं), तब से यह कोड के साथ कोड है।

लेकिन या तो संकलक के लिए काम करता है, इसलिए यह व्यक्तिगत स्वाद/आपके संगठन के कोडिंग मानकों पर निर्भर है।

2

राय: पहली विधि बेहतर है। एक तरह से एनोटेशन और विधि टिप्पणी से अधिक मजबूत है।

1

आम तौर पर विधि से पहले लाइन (या रेखाएं) पर टिप्पणियां होती हैं। एनोटेशन एक ही लाइन पर रखने के लिए थोड़ा लंबा हो सकता है।

हालांकि, @Override थोड़ा सा विशेष है। यह प्रभावी ढंग से उस भाषा के लिए तैयार हो रहा है जिसमें override नहीं है। परंपरागत रूप से यह एक ही पंक्ति पर रखा जाता है (हालांकि आप बहुत सारे उदाहरण देखेंगे जहां यह नहीं है)।

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