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

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

12 comments  source-code 

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

12 php  comments 

मैं एक "स्पेगेटी-कोड" प्रोजेक्ट पर काम कर रहा हूं, और जब मैं बग्स को ठीक कर रहा हूं और नई विशेषताओं को लागू कर रहा हूं, तो कोड यूनिट-टेस्ट करने योग्य बनाने के लिए मैं कुछ रीफैक्टरिंग भी करता हूं। कोड अक्सर इतना कसकर युग्मित या जटिल होता है कि …

11 refactoring  comments 

क्या नियमित अभिव्यक्तियों पर टिप्पणी करने के लिए कोई सामान्य प्रथाएं हैं: सभी अभिव्यक्ति के लिए RegEx या सामान्य टिप्पणी के विभिन्न भाग का उल्लेख करते हुए इनलाइन टिप्पणियां?

11 documentation  coding-style  comments 

मैं आज एक सहकर्मी के साथ बात कर रहा था। हम दो अलग-अलग परियोजनाओं के लिए कोड पर काम करते हैं। मेरे मामले में, मैं अपने कोड पर काम करने वाला एकमात्र व्यक्ति हूं; उसके मामले में, कई लोग एक ही कोडबेस पर काम करते हैं, जिसमें सह-सेशन वाले छात्र …

11 coding-style  team  comments 

मैं जावा में पदावनत वर्ग की पहचान करने के लिए टिप्पणी जोड़ने का सबसे अच्छा तरीका जानना चाहूंगा। क्या मुझे उस कक्षा के शीर्ष पर जोड़ी गई पिछली टिप्पणी को हटा देना चाहिए जो किसी अन्य प्रोग्रामर को यह जानने में मदद करती है कि वह कक्षा किस लिए थी, …

11 java  code-quality  api  comments 

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

11 documentation  comments 

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

10 .net  programming-practices  development-process  documentation  comments 

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

10 documentation  comments  intellisense 

क्या व्यापक रूप से ज्ञात विधियों जैसे समतुल्य, तुलना इत्यादि के लिए टिप्पणियां लिखना एक अच्छा अभ्यास है? नीचे दिए गए कोड पर विचार करें। /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code …

10 java  comments 

मैं रॉबर्ट सी। मार्टिन द्वारा क्लीन कोड पढ़ रहा हूं , और वाक्यांश TILTअनावश्यक रूप से कुछ कोड नमूनों में दिखाई देता है। उदाहरण (यह जावा में है, वैसे): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT: …

9 java  clean-code  comments  conventions 

मैं एक परियोजना छोड़ने वाला हूं, और इससे पहले कि मैं अपने बॉस को दस्तावेज़ कोड के लिए कहूं (मैंने बहुत अच्छी तरह से दस्तावेज नहीं किया है)। यह बड़ी बात नहीं है, यह परियोजना बहुत जटिल नहीं है। लेकिन मुझे अपने दस्तावेज़ में ऐसी जगह मिल रही हैं जहाँ …

9 documentation  comments 

मैं DRY तरीके से Javadoc लिखना चाहता हूँ। लेकिन Javadoc के बारे में ओरेकल दस्तावेज़ कहता है कि ओवरलोड विधि टिप्पणी में फिर से वही लिखें। क्या मैं पुनरावृत्ति से बच नहीं सकता?

9 documentation  comments  dry  javadocs 

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

9 comments 

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

9 documentation  comments  coding-style