Documentation
विषय
खोज…
परिचय
एक विषय बनाना
विषय बनाने के लिए निम्नलिखित चरणों का उपयोग करें:
- टैग के डैशबोर्ड पर
Create New Topicपर क्लिकCreate New Topic। - विषय का नाम बताइए।
- "उदाहरण" अनुभाग में विस्तृत उदाहरण प्रदान करें।
- यदि आपके पास साझा करने के लिए अधिक है, तो "सिंटैक्स," "पैरामीटर," और "रिमार्क्स" अनुभागों का उपयोग करें।
आपने सफलतापूर्वक एक विषय बनाया है! विषय सभी के लिए उपलब्ध होगा, और हर कोई इसे संपादित कर सकता है।
याद रखें कि स्टैक ओवरफ्लो डॉक्यूमेंटेशन में, उदाहरण शो के स्टार हैं!
एक विषय की शारीरिक रचना
एक विषय कई वर्गों से बना है:
शीर्षक: विषय का विषय क्या है। पहले से मौजूद विषयों को सुनिश्चित करें कि आप पहले से मौजूद सामग्री को नहीं दोहरा रहे हैं। स्टैक ओवरफ्लो पर पहले से ही कवर किए गए विषय हटाए जा सकते हैं।
संस्करण: वे संस्करण जहां विषय द्वारा कवर की गई सामग्री लागू होती है। आप परिचय विषय में सूचीबद्ध किसी भी संस्करण से चुन सकते हैं, या उन सभी को यह इंगित करने के लिए निकाल सकते हैं कि विषय सभी संस्करणों पर लागू होता है। अधिक जानकारी के लिए संस्करण देखें।
परिचय (वैकल्पिक): पाठकों और योगदानकर्ताओं दोनों के लिए निहित उदाहरणों के आयोजन सिद्धांत का वर्णन करता है। यह उदाहरणों से ऊपर रहता है और 500 अक्षरों तक सीमित है।
उदाहरण: विषय के लिए कोड उदाहरण। कोड को पढ़ना आसान है और अच्छी तरह से टिप्पणी की जानी चाहिए। कोड को समझने के लिए आवश्यक अवधारणाओं को समझाने के लिए गद्य का भी उपयोग किया जाना चाहिए, लेकिन कोशिश करें कि अत्यधिक क्रिया न हो।
प्रति विषय एक उदाहरण "पिन किया जा सकता है", जिसका अर्थ है कि यह अन्य उदाहरणों से ऊपर तैरता है। यह एक विस्तारित परिचय के लिए उपयोगी हो सकता है जो परिचय अनुभाग के लिए बहुत लंबा है।
सिंटैक्स (वैकल्पिक): हाथ में विषय के लिए एक सिंटैक्स शामिल करना उचित हो सकता है। यह अनुभाग हमेशा एक कोड ब्लॉक होता है और एक मार्कडाउन सूची होनी चाहिए:
- class.method(required_parameter [, optional])
- function f(int x) = { code defining what the function does }
पैरामीटर (वैकल्पिक) : जब किसी विषय को सिंटैक्स के साथ वर्णित किया जाता है, तो पैरामीटर विवरण शामिल करना भी उपयुक्त हो सकता है। पैरामीटर को दो-स्तंभ तालिका के रूप में स्वरूपित किया जाता है:
| Parameter | Details |
| --------- | ------- |
| yin | dark |
| yang | light |
टिप्पणी (वैकल्पिक) : विषय के बारे में कोई अतिरिक्त जानकारी जो अंतिम पाठक के लिए मूल्यवान साबित हो सकती है। रिमार्क्स फ़्रीफ़ॉर्म हैं।
परिचयात्मक विषय
जब एक नया प्रलेखन टैग बनाया जाता है, तो StackOverflow स्वचालित रूप से एक परिचयात्मक विषय उत्पन्न करता है, जो पहले वास्तविक विषय के लिए प्लेसहोल्डर के रूप में कार्य करता है।
परिचयात्मक विषय में नए प्रलेखन टैग पर विस्तार में मदद करने के लिए सही दिशा में योगदान करने के लिए प्लेसहोल्डर ग्रंथों और संकेत होते हैं।
कृपया ध्यान दें कि परिचयात्मक विषयों को हटाया नहीं जा सकता है। इस प्रश्न को देखें
