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

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

11 documentation 

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

11 agile  documentation  architecture  dry 

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

11 project-management  business  management  documentation 

हमारे सॉफ्टवेयर में कई वर्ग हैं जिन्हें गतिशील रूप से प्रतिबिंब के माध्यम से पाया जाना चाहिए। सभी वर्गों में एक विशिष्ट हस्ताक्षर के साथ एक कंस्ट्रक्टर होता है जिसके माध्यम से प्रतिबिंब कोड वस्तुओं को त्वरित करता है। हालाँकि, जब कोई जाँचता है कि क्या विधि संदर्भित है (उदाहरण …

11 c#  .net  documentation  reflection 

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

11 documentation  comments 

मेरी राय में, इकाई परीक्षण के मामले स्वयं कोड के लिए एक दस्तावेज के रूप में काम करते हैं। मेरी कंपनी चाहती है कि मैं इकाई परीक्षण मामलों के शीर्ष पर विस्तृत जावा डॉक टिप्पणी लिखूं। क्या ऐसा करना जरूरी है? क्या आप इस तरह की टिप्पणी लिखते हैं?

11 unit-testing  documentation 

मैं एक शौकिया डेवलपर हूं और अब तक के मेरे सभी कार्यक्रम कोड के भीतर प्रलेखित होने के लिए काफी सरल थे। कोड को पढ़ते समय यह स्पष्ट था कि मैं ऐसा क्या कर रहा था और इस तरह की कार्रवाई (मेरा मानक परीक्षण 6 महीने बाद कोड को देखने …

10 architecture  documentation 

हम एक वाणिज्यिक पुस्तकालय और कोड उदाहरण बनाते हैं जो बाहरी डेवलपर्स द्वारा उपयोग किए जा रहे हैं। हमारे पास (पंजीकृत उपयोगकर्ताओं के लिए उपलब्ध है) प्रलेखन, जो बड़े पैमाने पर पुस्तकालय का उपयोग करने के बारे में बताता है। कई डेवलपर्स पहली बार उपयोगकर्ता हैं, इसलिए बहुत अधिक अल्पविकसित …

10 documentation  api-design  error-handling  error-messages 

मैं किसी प्रोजेक्ट पर एकमात्र डेवलपर हूं, जो किसी भी सॉफ्टवेयर प्रोजेक्ट के लिए, भविष्य में किसी और के द्वारा लिया जा सकता है। मान लीजिए कि मैंने सुविधा ए को लागू करने के लिए पैटर्न X का उपयोग किया था। फीचर के विकास और परिष्करण के बाद, मुझे एहसास …

10 design-patterns  refactoring  documentation 

क्या जानकारी आपको github README में देखने की उम्मीद है? क्या README में सब कुछ जाना चाहिए? अर्थात परिचय स्थापना संस्करण उपयोगकर्ता गाइड कार्यान्वयन परिक्षण संबंधित संसाधन या क्या आपको आरईएडीएमई (परिचय, स्थापना, संस्करण) में कुछ चीजें डालनी चाहिए और अन्य जानकारी को गिथुबिकी में रखा जाना चाहिए?

10 documentation  github 

मैं प्रलेखन के लिए XML टिप्पणियों की आवश्यकता का प्रशंसक हुआ करता था। मैंने दो मुख्य कारणों से अपना विचार बदल दिया है: अच्छे कोड की तरह, तरीके आत्म-व्याख्यात्मक होने चाहिए। व्यवहार में, अधिकांश XML टिप्पणियां बेकार शोर हैं जो कोई अतिरिक्त मूल्य प्रदान नहीं करते हैं। कई बार हम …

10 .net  programming-practices  development-process  documentation  comments 

हम इस समय अपनी वर्तमान परियोजना में चुस्त तरीकों का उपयोग कर रहे हैं, और हमारे पास इन जैसी कहानियों के ढेर हैं: एक सहायक के रूप में, मैं ग्राहक को धनवापसी का भुगतान करना चाहता हूं ताकि जब वे अनुरोध करें तो उन्हें कुछ पैसा मिल सके एक ग्राहक …

10 agile  documentation  requirements  user-story 

जहाँ मैं वर्तमान में सामान्य दृष्टिकोण का काम कर रहा हूँ - जितना संभव हो प्रलेखन से बचें केवल एक दस्तावेज अगर एक अलग टीम को इसकी आवश्यकता होगी स्पष्टीकरण के लिए, मेरा मतलब कोड-प्रलेखन नहीं है - यह हम करते हैं, मेरा मतलब है कि डिज़ाइन प्रक्रिया के आसपास …

10 documentation 

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

10 documentation  training 

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

10 documentation  comments  intellisense