गो में उदाहरण फ़ंक्शन क्या हैं?

चाबी छीनना

• गो में उदाहरण फ़ंक्शन परीक्षण योग्य कोड स्निपेट हैं जो दस्तावेज़ीकरण के रूप में कार्य करते हैं और शुद्धता को सत्यापित करने के लिए उपयोग किए जा सकते हैं।
• उदाहरण फ़ंक्शन एक नामकरण परंपरा का पालन करते हैं और पैकेज, फ़ंक्शन, प्रकार और विधियों के लिए परिभाषित किए जा सकते हैं।
• उदाहरण फ़ंक्शन निष्पादन योग्य परीक्षण हैं और इनका उपयोग विश्वसनीय कोड सुनिश्चित करने और दस्तावेज़ीकरण को अद्यतन रखने के लिए किया जा सकता है।

गो की एक खूबी इसकी अंतर्निहित परीक्षण और दस्तावेज़ीकरण सुविधाओं की प्रचुरता है। इनमें से एक अत्यधिक उपयोगी उपकरण है जिसे "उदाहरण फ़ंक्शन" कहा जाता है जो आपके कोड की जांच करने और इसे दूसरों को समझाने में आपकी सहायता कर सकता है।

एक गो डेवलपर के रूप में, आपको यह समझना चाहिए कि उदाहरण फ़ंक्शन क्या हैं और आप रखरखाव योग्य सॉफ़्टवेयर बनाने के लिए उनका उपयोग कैसे कर सकते हैं।

उदाहरण कार्य क्या हैं?

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

कल्पना कीजिए कि आपके पास निम्नलिखित है गुणा अपने प्रोजेक्ट में कार्य करें:

funcMultiply(a, b int)int {
return a * b
}

के लिए एक उदाहरण फ़ंक्शन गुणा इस तरह दिखेगा:

funcExampleMultiply() {
 fmt.Println(Multiply(4, 5))
// Output: 2
}

उदाहरण फ़ंक्शंस परीक्षण फ़ंक्शंस के लिए समान नामकरण परंपरा का उपयोग करते हैं। फ़ंक्शन के नाम को "उदाहरण" में प्रत्यय के रूप में जोड़कर फ़ंक्शन उदाहरण को परिभाषित करें, जैसा कि मामले में है उदाहरण गुणन यहाँ।

उदाहरण फ़ंक्शंस पर करीब से नज़र डालें

पिछले अनुभाग में कोड एक उदाहरण फ़ंक्शन की मूल संरचना दिखाता है। जो चीज़ एक उदाहरण बनाती है वह नाम, फ़ंक्शन बॉडी और फ़ंक्शन के अंत में एक वैकल्पिक आउटपुट टिप्पणी है।

जब आप आउटपुट टिप्पणी जोड़ते हैं, तो गो इसकी शुद्धता को सत्यापित करने के लिए उदाहरण को संकलित और निष्पादित करता है, लेकिन टिप्पणी के बिना, गो केवल उदाहरण फ़ंक्शन को संकलित करता है, इसे निष्पादित नहीं करता है।

आप एक पैकेज, एक फ़ंक्शन, एक प्रकार और एक प्रकार पर एक विधि के लिए एक उदाहरण परिभाषित कर सकते हैं।

विभिन्न संस्थाओं के लिए उदाहरणों को परिभाषित करने के लिए अलग-अलग दृष्टिकोण की आवश्यकता होती है।

1. किसी पैकेज के लिए एक उदाहरण परिभाषित करने के लिए, बस अपने फ़ंक्शन को कॉल करें उदाहरण(), बिना किसी प्रत्यय के। उदाहरण के लिए, यहां एक पैकेज-स्तरीय उदाहरण दिया गया है:

   funcExample() {
    fmt.Println("Hello, world!")
   // Output:
   // Hello, world!
   }

2. किसी फ़ंक्शन के लिए एक उदाहरण परिभाषित करने के लिए, आप बस फ़ंक्शन नाम को प्रत्यय के रूप में जोड़ते हैं जैसा कि आपने पहले सीखा था।

   funcExampleMultiply() {
    fmt.Println(Multiply(4,5))
   // Output: 2
   }
   

3. किसी प्रकार के लिए एक उदाहरण परिभाषित करने के लिए, नाम को प्रत्यय के रूप में जोड़ें उदाहरण. यहाँ एक उदाहरण है:

   type MyStruct struct {
   // ...
   }
   funcExampleMyStruct() {
   // ...
   }
   

4. और अंत में, किसी विशेष प्रकार की विधि के लिए, आप प्रकार का नाम, एक अंडरस्कोर और फिर विधि का नाम जोड़ते हैं। यहाँ एक प्रदर्शन है:

   func(m *MyStruct)MyMethod() {
   // ...
   }
   funcExampleMyStruct_MyMethod() {
   // ...
   }
   

आप एक अतिरिक्त अंडरस्कोर और छोटे अक्षर से शुरू होने वाला प्रत्यय जोड़कर एक इकाई के लिए कई उदाहरण परिभाषित कर सकते हैं। उदाहरण के लिए, उदाहरणमल्टीप्लाई_सेकंड, उदाहरणमायस्ट्रक्चर_मायमेथोड_सेकंड.

का उपयोग करके जटिल तर्क को समझाने के लिए आपके पास एक बड़ा उदाहरण भी हो सकता है संपूर्ण फ़ाइल उदाहरण.

एक संपूर्ण फ़ाइल उदाहरण एक फ़ाइल है जो समाप्त होती है _परीक्षण.जाओ और इसमें बिल्कुल एक उदाहरण फ़ंक्शन, कोई परीक्षण या बेंचमार्क फ़ंक्शन और कम से कम एक अन्य पैकेज-स्तरीय घोषणा शामिल है। ऐसे उदाहरण प्रदर्शित करते समय गोडॉक पूरी फ़ाइल दिखाएगा। - गो देव ब्लॉग

गो इंजन आपके उदाहरण कार्यों को आपके परिभाषित करने के तरीके के अनुसार पहचानता है और संभालता है।

आप इसका उपयोग कर सकते हैं अव्यवस्थित आउटपुट आउटपुट टिप्पणियों के लिए विकल्प। यह उन परिदृश्यों में विशेष रूप से उपयोगी है जहां आपका फ़ंक्शन एक ऐसी सूची लौटाता है जो किसी विशिष्ट क्रम में अपेक्षित नहीं है।

उदाहरण कार्यों के साथ अपने कोड का दस्तावेज़ीकरण करना

उदाहरण फ़ंक्शन दस्तावेज़ीकरण और परीक्षण दोनों उद्देश्यों के लिए उपयोगी हैं। एक उदाहरण फ़ंक्शन आमतौर पर टिप्पणियों की तुलना में व्यवहार को समझाने का बेहतर काम करता है।

ठीक वैसा जावा का Javadoc, जाओ अंतर्निहित दस्तावेज़ीकरण उपकरण, गोडॉक, दस्तावेज़ कोड को आसानी से मदद करता है। लेकिन आप कुछ पुस्तकालयों और फ़ंक्शंस को एक साथ दस्तावेज़ित करना चाहेंगे ताकि वे कैसे काम करते हैं इसकी अधिक संपूर्ण समझ मिल सके। उदाहरण इस झटके को खत्म करते हैं क्योंकि वे एक पैकेज की विभिन्न इकाइयों के बीच बातचीत को प्रदर्शित कर सकते हैं।

गॉडोक टूल स्वचालित रूप से आपके विनिर्देशों के आधार पर उदाहरणों को उन कार्यों, प्रकारों और पैकेजों के साथ जोड़ता है जिनसे वे संबंधित हैं। यह दस्तावेज़ीकरण वेब इंटरफ़ेस के भीतर प्रयोग की अनुमति देकर एक कदम आगे बढ़ता है।

आप किसी पैकेज या विधि को अपने कोड में उपयोग करने से पहले दस्तावेज़ से ही आज़मा सकते हैं।

यह छवि इसके लिए एक उदाहरण दिखाती है json. वैध के अंतर्गत कार्य करें एन्कोडिंग/जेसन:

यूनिट परीक्षण के लिए उदाहरण फ़ंक्शंस का उपयोग करना

गो उदाहरण फ़ंक्शन भी निष्पादन योग्य परीक्षण हैं। जब आप चलाते हैं जाओ परीक्षण करो कमांड, इंजन प्रत्येक उदाहरण फ़ंक्शन को अंतिम आउटपुट टिप्पणी के साथ चलाता है और यह सुनिश्चित करता है कि उसका आउटपुट टिप्पणी में जो है उससे मेल खाता है।

यह क्षमता कई मायनों में उपयोगी है. यह एक अतिरिक्त परत के रूप में काम कर सकता है विश्वसनीय कोड सुनिश्चित करने के लिए परीक्षण, यह आपके कोड में परिवर्तन होने पर आपके दस्तावेज़ों पर नज़र रखने में भी आपकी सहायता करता है।

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

इससे पुराने दस्तावेज़ों को रोकने में बहुत मदद मिलती है, क्योंकि आपका दस्तावेज़ हमेशा कोड के साथ अद्यतित रहेगा।

उदाहरण फ़ंक्शन विश्वसनीय कोड और दस्तावेज़ीकरण तैयार करते हैं

दस्तावेज़ीकरण सॉफ़्टवेयर विकास का एक अनिवार्य हिस्सा है, लेकिन कुछ भाषाएँ आपको अपने कोड का दस्तावेज़ीकरण और परीक्षण करने के लिए इतना शक्तिशाली मंच प्रदान करती हैं।

गो आपके सॉफ़्टवेयर के लिए गुणवत्ता दस्तावेज़ बनाने के लिए आवश्यक हर चीज़ के साथ आता है, और उदाहरण फ़ंक्शन उसका एक महत्वपूर्ण हिस्सा हैं। उपयोगकर्ताओं और सहयोगियों को आपके कोड को तेज़ी से अपनाने और समझने में मदद करने के लिए उदाहरणों का उपयोग करें।