scala - Scaladoc [use case] -

Scaladoc में कुछ विधि विवरण क्यों [मामले का उपयोग करें] P> उदाहरण: scala.collection.immutable.StringOps। ++

क्या यह भविष्य में प्रतिस्थापित करने के लिए केवल एक प्लेसहोल्डर है?

ये सरल तरीके हैं कि इन तरीकों को कैसे कहा जाता है आम तौर पर इन विधियों ( ++ , नक्शा , फ्लैटमैप , आदि) में एक अंतर्निहित पैरामीटर होता है, अक्सर एक तर्क जिसे एक बिल्डर कारखाने कहा जाता है (जो कि परिणामस्वरूप संग्रह के सृजन सार)।

ज्यादातर मामलों में, एक संग्रह का ग्राहक इन अंतर्निहित मानकों को निर्दिष्ट नहीं करता है, इसलिए स्कालेडॉक विधि का सरलीकृत वर्णन परिभाषित करने की अनुमति देता है - एक उपयोग केस < / strong>। यह उपयोगकर्ताओं को सवाल में विधि के बारे में जल्दी से सोचने के लिए सक्षम बनाता है, और इस पर ध्यान नहीं दिया जाता है कि उदाहरण के लिए, यह ++ की पूर्ण घोषणा है:

     अधिकांश मामलों में, डीईएफ़ ++ [बी एंड जी: ए, एट] (जो: ट्रैवर्सबल एक बार [बी]) (निहित बीएफ: कैनबिलफ्रम [रेप्र, बी, वो]): यह   
 लक्ष्य संग्रह प्रकार कॉल के रिसीवर के समान है, इसलिए कॉल बहुत ज्यादा दिखती है कि घोषणा निम्न है (मानते हुए  ++  पर परिभाषित किया गया है, कहते हैं,  सूची < / Code>):  
  def ++ (जो: ट्रॉसेसेबल एक बार [ए]): सूची [ए]   
 ऊपर, संकलित संकलन को संकलित किया जाता है समय, और प्रकार पैरामीटर अनुमानित हैं। ज्यादातर मामलों में, यह विधि का ग्राहक का दृष्टिकोण होना चाहिए।  
 और अगर आप अपनी खुद की विधि को उपयोग के मामलों के साथ एनोटेट करना चाहते हैं, तो अपने डॉक टिप्पणियों में  @usecase  टैग का उपयोग करें :  
  / ** ... * ... * @usecase def ++ (वह: ट्रॉसेसेबल एक बार [ए]): सूची [ए] * /