Scala Language
Scaladoc
खोज…
वाक्य - विन्यास
- तरीकों, क्षेत्रों, कक्षाओं या पैकेजों से ऊपर जाता है।
- के साथ शुरू होता है
/**
- प्रत्येक पंक्ति में टिप्पणियों के साथ एक प्रारंभिक
*
- के साथ समाप्त होता है
*/
पैरामीटर
पैरामीटर | विवरण |
---|---|
वर्ग विशेष | _ |
@constructor detail | वर्ग के मुख्य निर्माता को स्पष्ट करता है |
विधि विशिष्ट | _ |
@return detail | विधि पर क्या लौटा है, इसके बारे में विवरण। |
विधि, कंस्ट्रक्टर और / या कक्षा टैग | _ |
@param x detail | किसी विधि या निर्माता पर मान पैरामीटर x बारे में विवरण। |
@tparam x detail | किसी विधि या निर्माता पर टाइप पैरामीटर x बारे में विवरण। |
@throws detail | क्या अपवाद फेंके जा सकते हैं। |
प्रयोग | _ |
@see detail | जानकारी के अन्य स्रोतों का संदर्भ लें। |
@note detail | पूर्व या पोस्ट की स्थिति, या किसी अन्य उल्लेखनीय प्रतिबंध या अपेक्षाओं के लिए एक नोट जोड़ता है। |
@example detail | उदाहरण कोड या संबंधित उदाहरण प्रलेखन प्रदान करता है। |
@usecase detail | पूर्ण विधि परिभाषा बहुत जटिल या शोर है जब के लिए एक सरलीकृत विधि परिभाषा प्रदान करता है। |
अन्य | _ |
@author detail | निम्नलिखित के लेखक के बारे में जानकारी प्रदान करता है। |
@version detail | संस्करण है कि इस हिस्से के अंतर्गत आता है प्रदान करता है। |
@deprecated detail | निम्न इकाई को पदावनत के रूप में चिह्नित करता है। |
विधि के लिए सरल स्कैलडोक
/**
* Explain briefly what method does here
* @param x Explain briefly what should be x and how this affects the method.
* @param y Explain briefly what should be y and how this affects the method.
* @return Explain what is returned from execution.
*/
def method(x: Int, y: String): Option[Double] = {
// Method content
}
Modified text is an extract of the original Stack Overflow Documentation
के तहत लाइसेंस प्राप्त है CC BY-SA 3.0
से संबद्ध नहीं है Stack Overflow