चूंकि हम पहले से ही जानते हैं कि मल्टीलाइन टिप्पणियों को कैसे लिखना है, हम या तो ट्रिपल सिंगल कोट्स या ट्रिपल डबल कोट्स का उपयोग कर सकते हैं। जब हम अपने कार्यों का वर्णन करना चाहते हैं तो हम दस्तावेज़ीकरण स्ट्रिंग का उपयोग करते हैं ताकि जब हमें इसकी आवश्यकता हो तो हम दस्तावेज़ीकरण प्राप्त कर सकें। कुछ आईडीई आपको केवल नाम पर होवर करके दस्तावेज़ीकरण देते हैं और कुछ कुछ कीवर्ड को हाइलाइट करते हैं। लेकिन तथ्य यह है कि NumPy में डॉकस्ट्रिंग अन्य भाषाओं की तुलना में अधिक लचीली हैं। डॉकस्ट्रिंग एक स्ट्रिंग अक्षर है जो फ़ंक्शन परिभाषा की शुरुआत में होता है। कार्यों, कक्षाओं आदि के मामलों में डॉकस्ट्रिंग का उपयोग करते समय हमें विशिष्ट मूल्य प्रदान करना होगा।
कार्यों के साथ डॉकस्ट्रिंग का उपयोग करते समय, हमें तर्कों को पारित करना होगा। कक्षाओं के साथ उनका उपयोग करते समय, हम विशेषताओं और विधियों को पास करते हैं। मॉड्यूल के मामले में, हमें कक्षाओं और कार्यों की एक सूची प्रदान करनी होगी। पैकेज के मामले में, हम कार्यक्षमता वाले मॉड्यूल की सूची पास करते हैं। तो मूल रूप से, डॉकस्ट्रिंग का उद्देश्य है, जैसा कि नाम से पता चलता है, कि यह हमारे कोड के दस्तावेज़ीकरण में मदद करता है। हम दस्तावेज़ीकरण करते हैं ताकि अगर कोई भविष्य में हमारे कोड का उपयोग करता है, तो वह डॉकस्ट्रिंग की मदद से हमारे कोड और हमारे कोड के पीछे के तर्क को समझ सकेगा। बिल्ट-इन फ़ंक्शंस में डॉकस्ट्रिंग भी होते हैं; हम बिल्ट-इन फंक्शन के डॉकस्ट्रिंग को देखने के लिए हेल्प () के फंक्शन का उपयोग कर सकते हैं।
टिप्पणियों और डॉकस्ट्रिंग के बीच कुछ अंतर हैं। टिप्पणियों को दुभाषियों द्वारा अनदेखा किया जाता है लेकिन दुभाषियों द्वारा डॉकस्ट्रिंग को अनदेखा नहीं किया जाता है। डॉकस्ट्रिंग के लिए मेमोरी आवंटित की जाती है। एक टिप्पणी कोड का विवरण है लेकिन दूसरी ओर, डॉकस्ट्रिंग हमें कोड का उद्देश्य बताते हैं।
वाक्य - विन्यास:
NumPy में डॉकस्ट्रिंग लिखने का सिंटैक्स है:
'''डॉकस्ट्रिंग संदेश'''
या
'''डॉकस्ट्रिंग संदेश'''
कृपया ध्यान दें कि डॉकस्ट्रिंग कोई फ़ंक्शन या विधि नहीं है, इसलिए इसमें उचित सिंटैक्स नहीं है। यहां केवल ध्यान देने वाली बात यह है कि हम डॉकस्ट्रिंग को तीन सिंगल कोट्स या तीन डबल कोट्स के साथ शुरू करते हैं। हम कोड का अपना विवरण लिखते हैं और अंत में तीन सिंगल कोट्स या तीन डबल कोट्स के साथ इसे फिर से समाप्त करते हैं। डॉकस्ट्रिंग के लिए लिखने के लिए कोई अनिवार्य बात नहीं है। आपको अपने स्ट्रिंग विवरण के पहले और बाद में केवल तीन सिंगल या डबल कोट्स डालने होंगे।
उदाहरण 1:
डॉकस्ट्रिंग को बेहतर तरीके से समझने के लिए, आइए एक उदाहरण करते हैं। इस उदाहरण में, NumPy लाइब्रेरी को शामिल करने के बाद, हम केवल वेरिएबल 'a' और दूसरा वेरिएबल 'b' घोषित करते हैं। उसके बाद, हम अपना डॉकस्ट्रिंग बनाते हैं जो कहता है कि 'आइए हम' ए 'और' बी 'वेरिएबल जोड़ें'। हमारे मामले में, यह एक आसान उदाहरण है लेकिन यदि हमारा कोड जटिल है, तो यह कोड को समझने में कोडर की बहुत मदद करता है। उसके बाद, हम वेरिएबल्स 'ए' और 'बी' को जोड़ते हैं और उनके आउटपुट परिणाम को दूसरे वेरिएबल में स्टोर करते हैं जो 'सी' है। अंत में, हम वेरिएबल 'c' के मान को प्रिंट करते हैं। अब, हम अपना कोड निष्पादित करते हैं।
आयात Numpy जैसा जैसेएक = 1
बी = दो
'''आइए ए और बी वेरिएबल जोड़ें''
सी = ए+बी
प्रिंट ( सी )
यह दिए गए कोड के टुकड़े से हमारा आउटपुट है। हम देख सकते हैं कि सिस्टम ने हमारे कोड की लाइन 7 के लिए गलत सिंटैक्स या किसी भी चीज़ के बारे में कोई त्रुटि नहीं दी है। साथ ही, सिस्टम ने हमारे डॉकस्ट्रिंग को प्रिंट नहीं किया है। इसके बजाय, इसने केवल हमारे वेरिएबल 'c' के आउटपुट को प्रिंट किया जिसमें हमने अपने सिस्टम को प्रिंट करने के लिए कहा था। यह दिखाता है कि डॉकस्ट्रिंग कैसे काम करती है। अगली बार, जब कोई नया कोडर हमारे कोड पर काम करने की कोशिश करेगा, तो वह समझ जाएगा कि हम अपने डॉकस्ट्रिंग की मदद से क्या कर रहे हैं। लेकिन इसे आउटपुट के रूप में प्रिंट नहीं किया जाएगा, इसलिए कोड का उपयोगकर्ता इससे परेशान नहीं होगा।
उदाहरण 2:
अब, हम डॉकस्ट्रिंग की कार्यप्रणाली को समझने के लिए एक जटिल उदाहरण प्रस्तुत करते हैं। सबसे पहले, हम NumPy लाइब्रेरी को शामिल करते हैं और फिर एक डॉक स्ट्रिंग लिखते हैं जिसमें हम कोड की अगली लाइन की व्याख्या करते हैं जहाँ हम ऐरे के इनिशियलाइज़ेशन की व्याख्या करते हैं। हम कोड के दूसरे भाग में डॉकस्ट्रिंग भी जोड़ते हैं। अब, अगर हम बिना डॉकस्ट्रिंग जोड़े किसी भी नए पायथन डेवलपर के साथ इस कोड को साझा करते हैं, तो उसके लिए इस कोड के काम और उद्देश्य को जानना किसी भी तरह मुश्किल होगा। उसे पहले हमारे द्वारा उपयोग किए जाने वाले कार्यों के बारे में खोजना होगा। लेकिन अगर हम अपने कोड में एक डॉकस्ट्रिंग जोड़ते हैं, तो अन्य डेवलपर्स के लिए फ़ंक्शन के बारे में अधिक अध्ययन किए बिना कोड को समझना आसान होगा। हम टिप्पणियों को कुछ सीमाओं में जोड़ने तक ही सीमित नहीं हैं; टिप्पणियाँ एक या एक से अधिक पंक्तियों की हो सकती हैं। इसे एक कोड में एक से अधिक बार भी जोड़ा जा सकता है। फिर, NumPy को np के रूप में आयात करें।
'''वेरिएबल बनाना जिससे हम 1x6 आकार की एक सरणी पास करेंगे''सरणी = जैसे सरणी ( [ ग्यारह , 22 , 33 , 44 , 55 , 66 ] )
''' टोफाइल () फंक्शन को ऐरे असाइन करना ताकि इसे एरर नाम की फाइल में सेव किया जा सके।''
सरणी . फाइल करने के लिए ( 'गिरफ्तारी बिन' )
'''फ्रॉमफाइल फंक्शन का उपयोग कर फाइल प्रदर्शित करें'''
प्रिंट ( जैसे लेख्यपत्र से ( 'गिरफ्तारी बिन' , डीटाइप = पूर्णांक ) )
जैसा कि निम्नलिखित स्निपेट में दिखाया गया है, डॉकस्ट्रिंग आउटपुट में प्रदर्शित नहीं होते हैं, जिसका अर्थ है कि यह कोड के आउटपुट या संकलन को प्रभावित नहीं करता है। संकलन प्रक्रिया के दौरान डॉकस्ट्रिंग को अनदेखा किया जाता है।
निष्कर्ष
इस गाइड में, हमने NumPy में डॉकस्ट्रिंग के बारे में सीखा। हमने डॉकस्ट्रिंग की तुलना टिप्पणियों से की और उन दोनों के बीच के अंतर को समझाया। हमने अपने कोड में डॉकस्ट्रिंग्स के सिंटैक्स और डॉकस्ट्रिंग्स को लिखने का तरीका सीखा। इसके अलावा, हमने यह भी समझाने की कोशिश की कि NumPy में डॉकस्ट्रिंग क्या हैं और वे उदाहरणों की मदद से कैसे काम करते हैं। अंत में, हमने टिप्पणी की कि वे कोडर्स के लिए आवश्यक हैं। हम NumPy में डॉकस्ट्रिंग के महत्व को नहीं दोहराएंगे। हम सिर्फ इतना कहेंगे कि आपको अपने कोड में डॉकस्ट्रिंग का उपयोग करना चाहिए। NumPy में, डॉकस्ट्रिंग की लेखन शैली सबसे लोकप्रिय है। यह प्रोग्रामिंग समुदाय में व्यापक रूप से एक दूसरे को उनके कोड की कार्यप्रणाली और कार्यक्षमता के बारे में बताने के लिए उपयोग किया जाता है। यह मार्गदर्शिका आपको NumPy docstrings के साथ आरंभ करने में मदद करेगी। हमने NumPy में docstrings का उपयोग करके आपको जो कुछ भी चाहिए, उसमें से अधिकांश को कवर करने का प्रयास किया।