documentation पर टैग किए गए जवाब

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

1
कुछ भाषाओं पर प्रलेखन "समान" के बजाय "समतुल्य" क्यों है?
कुछ भाषाओं पर प्रलेखन "के बजाय" के बराबर "क्यों है?" उदाहरण के लिए, पायथन डॉक्स कहते हैं itertools.chain(*iterables) ... के बराबर : def chain(*iterables): # chain('ABC', 'DEF') --> A B C D E F for it in iterables: for element in it: yield element या इस C ++ संदर्भ पर …

6
मैं न्यूनतम समय की समीक्षा के लिए अपने कोड को कैसे प्रलेखित करूं? [बन्द है]
बंद हो गया । इस प्रश्न पर अधिक ध्यान देने की आवश्यकता है । यह वर्तमान में उत्तर स्वीकार नहीं कर रहा है। इस प्रश्न को सुधारना चाहते हैं? प्रश्न को अपडेट करें ताकि यह इस पोस्ट को संपादित करके केवल एक समस्या पर केंद्रित हो । पिछले साल बंद …

8
क्या आपको सब कुछ या सिर्फ सबसे अधिक दस्तावेज़ करना चाहिए?
यह कुछ भी विवादास्पद विषय लगता है कि "जावाबीन" सिंटैक्स प्राप्त करने और खेतों के लिए बसने सहित सब कुछ दस्तावेज करने के लिए: लोग कहते हैं कि इसकी अनावश्यक रूप से लंबी और दोहराव तोड़ने वाली DRY (खुद को दोहराएं नहीं) , कि नामकरण सम्मेलन सब कुछ समझा सकता …

6
क्या यूनिट परीक्षण वास्तव में प्रलेखन के रूप में उपयोग किए जाते हैं?
'यूनिट टेस्ट के तहत कोड के प्रलेखन का एक बहुत ही महत्वपूर्ण स्रोत हैं' के विवरण में मैं जितनी बार पढ़ता हूं उतनी बार गिनती नहीं कर सकता। मैं इनकार नहीं करता कि वे सच हैं। लेकिन व्यक्तिगत रूप से मैंने स्वयं को दस्तावेज के रूप में उपयोग करते हुए …

5
मुझे अपनी विशिष्टताओं को किस व्याकरणिक काल में लिखना चाहिए?
वर्तमान में हम दो कॉलम प्रारूप में कार्यात्मक और तकनीकी विनिर्देश लिख रहे हैं; सारांश वाक्य और तकनीकी विवरण। विवरण अक्सर चित्र, लेआउट डिजाइन ect के साथ एक परिशिष्ट का उल्लेख करते हैं। हालाँकि मैं इसे लिखने में कितना तनाव झेल रहा हूँ: पिछले तनाव के साथ जैसे कि काम …

4
जावा प्रोग्राम की उच्च-स्तरीय संरचना का दस्तावेजीकरण कैसे करें?
पृष्ठभूमि: मेरे सहयोगी और मैं एक अकादमिक पत्रिका के लिए एक लेख लिख रहे हैं। हमारे शोध के क्रम में, हमने जावा में एक सिमुलेशन कार्यक्रम लिखा। हम अनुकरण कार्यक्रम को दूसरों के उपयोग के लिए स्वतंत्र रूप से उपलब्ध कराना चाहते हैं। हमने एक GitHub रिपॉजिटरी पर कोड होस्ट …

1
इंटरफ़ेस कार्यान्वयन पर डुप्लिकेटिंग प्रलेखन अच्छा या बुरा ओवरराइड करता है?
तो हमारे पास एक इंटरफ़ेस है जैसे /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } हाल ही में, हमने एक प्रलेखन …

6
पुराना प्रोग्रामर गायब हो गया। एक और प्रोग्रामर को काम पर रखने के बारे में। मैं यह कैसे संपर्क करूं? [बन्द है]
बंद हो गया । यह सवाल राय आधारित है । यह वर्तमान में उत्तर स्वीकार नहीं कर रहा है। इस प्रश्न को सुधारना चाहते हैं? प्रश्न को अपडेट करें ताकि इस पोस्ट को संपादित करके तथ्यों और उद्धरणों के साथ उत्तर दिया जा सके । 6 साल पहले बंद हुआ …

4
कोड में गणितीय तर्क का दस्तावेजीकरण
कभी-कभी, हालांकि अक्सर नहीं, मुझे अपने कोड में गणित तर्क को शामिल करना होगा। उपयोग की जाने वाली अवधारणाएं ज्यादातर बहुत सरल हैं, लेकिन परिणामी कोड नहीं है - अस्पष्ट उद्देश्य के साथ बहुत सारे चर, और कुछ ऑपरेशन जो स्पष्ट इरादे के साथ नहीं हैं। मेरा मतलब है नहीं …

6
स्व-दस्तावेजीकरण कोड बनाम जावदोक?
हाल ही में मैं कोड आधार के उन हिस्सों को फिर से बनाने पर काम कर रहा हूं जो मैं वर्तमान में काम कर रहा हूं - न केवल इसे खुद को बेहतर समझने के लिए, बल्कि उन लोगों के लिए भी इसे आसान बनाने के लिए जो कोड पर …

7
क्या सॉफ्टवेयर विकास के लिए दस्तावेजों को संग्रहीत करने के लिए विकी वास्तव में उपयुक्त हैं? [बन्द है]
बंद हो गया । यह सवाल राय आधारित है । यह वर्तमान में उत्तर स्वीकार नहीं कर रहा है। इस प्रश्न को सुधारना चाहते हैं? प्रश्न को अपडेट करें ताकि इस पोस्ट को संपादित करके तथ्यों और उद्धरणों के साथ उत्तर दिया जा सके । 5 साल पहले बंद हुआ …

11
आपको अपने उत्तराधिकारियों के लिए क्या छोड़ना चाहिए?
मान लें कि आप एक नौकरी छोड़ने वाले एकमात्र डेवलपर हैं। कोड के बाहर किस तरह की जानकारी / सामग्री, आपको अपने प्रतिस्थापन के लिए बनाना और छोड़ना चाहिए? एक स्पष्ट उत्तर यह है कि "जो भी आप एक नई नौकरी में चाहते हैं" निश्चित रूप से होगा, लेकिन जब …

6
क्या किसी विधि के हस्ताक्षर में हर पैरामीटर के लिए एक javadoc टिप्पणी लिखना आवश्यक है?
मेरी टीम में से एक देवता का मानना ​​है कि किसी विधि के हस्ताक्षर में हर पैरामीटर के लिए एक javadoc टिप्पणी लिखना आवश्यक है। मुझे नहीं लगता कि यह आवश्यक है, और वास्तव में मुझे लगता है कि यह हानिकारक भी हो सकता है। सबसे पहले, मुझे लगता है …

2
830-1998 को किस मानक पर रखा गया है?
मैं औपचारिक रूप से सॉफ़्टवेयर प्रोजेक्ट्स को दस्तावेज़ में कैसे देख रहा हूं, और मुझे IEEE 830-1998 के बारे में पता चला है : सॉफ्टवेयर के लिए अनुशंसित अभ्यास विनिर्देशों । हालाँकि, जैसा कि आप उस लिंक से देख सकते हैं, इसे अलग कर दिया गया है। मुझे पता है …

5
न्यूनतम सिस्टम आवश्यकताएँ कैसे निर्धारित की जाती हैं?
हम सभी ने सॉफ्टवेयर के अनगिनत उदाहरण देखे हैं जो निम्नलिखित की तरह "न्यूनतम सिस्टम आवश्यकताओं" के साथ जहाज करते हैं: विंडोज एक्सपी / विस्टा / 7 1 जीबी रैम 200 एमबी स्टोरेज ये आम तौर पर कैसे निर्धारित होते हैं? स्पष्ट रूप से कभी-कभी विशिष्ट बाधाएं होती हैं (यदि …

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.