गो में एपीआई दस्तावेज में उदाहरण कैसे जोड़ें?

Question

गो मानक पुस्तकालय में कुछ अच्छे executable examples हैं। मैं अपने स्वयं के एपीआई दस्तावेज में ऐसा उदाहरण कैसे जोड़ सकता हूं? $ go help testfunc की

Answer 1

आउटपुट:

'जाना परीक्षण' कमांड परीक्षण, बेंचमार्क को खोजने के लिए उम्मीद है, और उदाहरण के परीक्षण के अंतर्गत पैकेज के लिए इसी "* _test.go" फ़ाइलों में कार्य करता है।

एक परीक्षण समारोह एक TestXXX और हस्ताक्षर होना चाहिए (जहां XXX किसी भी अल्फ़ान्यूमेरिक स्ट्रिंग एक लोअर केस पत्र के साथ शुरू नहीं है),

func TestXXX(t *testing.T) { ... } 

नाम पर है एक बेंचमार्क समारोह एक का नाम है BenchmarkXXX और, हस्ताक्षर होना चाहिए

func BenchmarkXXX(b *testing.B) { ... } 

एक उदाहरण फ़ंक्शन एक परीक्षण फ़ंक्शन के समान है, लेकिन सफलता या विफलता की रिपोर्ट करने के लिए * test.T का उपयोग करने के बजाय, os.Stdout और os.Stderr को आउटपुट प्रिंट करता है। उस आउटपुट की तुलना फ़ंक्शन की "आउटपुट:" टिप्पणी के विरुद्ध की जाती है, जो फ़ंक्शन बॉडी में अंतिम टिप्पणी होनी चाहिए (नीचे उदाहरण देखें)। उदाहरण के साथ ऐसी कोई टिप्पणी नहीं है, या "आउटपुट:" के बाद कोई टेक्स्ट नहीं है संकलित किया गया है लेकिन निष्पादित नहीं किया गया है।

गोडोक फ़ंक्शन, निरंतर, या चर XXX के उपयोग का उपयोग करने के लिए exampleXXX का शरीर प्रदर्शित करता है। रिसीवर प्रकार टी या * टी के साथ विधि एम का एक उदाहरण exampleT_M नाम दिया गया है। किसी दिए गए फ़ंक्शन, निरंतर, या चर के लिए कई उदाहरण हो सकते हैं, जो पीछे की ओर _xxx, द्वारा प्रतिष्ठित हैं जहां xxx एक प्रत्यय है जो ऊपरी केस अक्षर से शुरू नहीं होता है।

func ExamplePrintln() { 
     Println("The output of\nthis example.") 
     // Output: The output of 
     // this example. 
} 

पूरे परीक्षण फ़ाइल उदाहरण के रूप में प्रस्तुत किया जाता है, जब यह एक एकल उदाहरण समारोह होता है, कम से कम एक अन्य समारोह, प्रकार, चर:

यहाँ एक उदाहरण का एक उदाहरण है , या निरंतर घोषणा, और कोई परीक्षण या बेंचमार्क फ़ंक्शंस नहीं।

अधिक जानकारी के लिए परीक्षण पैकेज के दस्तावेज़ीकरण देखें।