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

कोड में टिप्पणी लिखने के बारे में प्रश्न।

4
गुण के XML प्रलेखन में "हो जाता है या सेट .." आवश्यक है?
मैं C # में XML टिप्पणियों के लिए एक सर्वोत्तम अभ्यास की सिफारिश की तलाश कर रहा हूं। जब आप कोई प्रॉपर्टी बनाते हैं, तो ऐसा लगता है कि अपेक्षित XML दस्तावेज़ीकरण के निम्नलिखित रूप हैं: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" …

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

9
अधिकांश प्रोग्रामिंग भाषाओं में टिप्पणियों को ब्लॉक क्यों नहीं किया जाता है?
कुछ लोग करते हैं, लेकिन उनमें से कोई भी लोकप्रिय नहीं है जहाँ तक मुझे पता है। क्या नेस्टिंग टिप्पणियों के बारे में कुछ बुरा है? मैं जिस छोटी सी भाषा पर काम कर रहा हूं, उसमें घोंसला टिप्पणी करने की योजना है, लेकिन मैं यह जानना चाहूंगा कि क्या …

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

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

8
क्या इनलाइन द्वारा 'एडिट' किए गए हैं, दुकानों में आदर्श है जो संशोधन नियंत्रण का उपयोग करते हैं?
हमारी दुकान के वरिष्ठ देव इस बात पर जोर देते हैं कि जब भी कोड को संशोधित किया जाता है, तो जिम्मेदार प्रोग्रामर को एक इनलाइन टिप्पणी जोड़ना चाहिए जिसमें कहा गया हो कि उसने क्या किया। ये टिप्पणियां आमतौर पर दिखती हैं// YYYY-MM-DD <User ID> Added this IF block …

5
एक कार्यक्रम की टिप्पणियों में क्यू एंड ए साइटों के लिए एक लिंक डालना ठीक है?
काफी कुछ कोडबेस में आप चीजों को बताते हुए देख सकते हैं: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) इसलिए मुझे कुछ सवाल मिले हैं, लेकिन वे सभी संबंधित हैं। क्या किसी कार्यक्रम की टिप्पणियों में SO प्रश्नों का लिंक देना ठीक है: // We're now …
16 comments 

7
NotImplementedException का उपयोग करें
क्या यह NotImplementedExceptionकोड के लिए फेंकने के लिए बुरा व्यवहार माना जाता है जो आपने अभी तक नहीं लिखा है? संभवतः TODO टिप्पणियों को अधिक सुरक्षित माना जाएगा?

16
क्या ऐसी भाषा जो टिप्पणियों को अधिक पठनीय कोड नहीं देती है? [बन्द है]
यहां क्या पूछा जा रहा है, यह बताना मुश्किल है। यह प्रश्न अस्पष्ट, अस्पष्ट, अपूर्ण, अति व्यापक या अलंकारिक है और इसका वर्तमान रूप में यथोचित उत्तर नहीं दिया जा सकता है। इस प्रश्न को स्पष्ट करने में मदद के लिए ताकि इसे फिर से खोला जा सके, सहायता केंद्र …
15 comments 

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

7
मुझे अपनी कक्षा के प्रलेखन हेडर में क्या शामिल करना चाहिए
मैं अपने एंटिटी, बिजनेस लॉजिक और डेटा एक्सेस क्लासेस के लिए सूचनात्मक वर्ग प्रलेखन प्रारूप की तलाश कर रहा हूं। मुझे यहाँ से दो प्रारूप मिले प्रारूप 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision …

4
क्या चेक-इन कोड में संघर्ष मार्करों को छोड़ने का औचित्य है?
संघर्ष मार्करों पर विचार करें। अर्थात: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD उस विशेष मामले में जिसने मुझे इस प्रश्न को पोस्ट करने के लिए प्रेरित किया है, जिम्मेदार टीम के सदस्य ने अभी-अभी हमारी शाखा में अपस्ट्रीम से एक मर्ज पूरा किया था, और …

6
टिप्पणी के रूप में आरेख के साथ एनोटेट स्रोत कोड
मैं बहुत सारे (मुख्य रूप से सी ++ और जावास्क्रिप्ट) कोड लिखता हूं जो कम्प्यूटेशनल ज्यामिति और ग्राफिक्स और उन प्रकार के विषयों पर छूता है, इसलिए मैंने पाया है कि दृश्य आरेख समस्याओं को हल करने की प्रक्रिया का एक अनिवार्य हिस्सा रहा है। मैंने अभी यह निर्धारित किया …

2
इनलाइन कोड टिप्पणियों के लिए सबसे अच्छा तरीका क्या है?
हम 20 साल की विरासत कोडबेस के लिए कुछ रिफैक्टिंग कर रहे हैं, और मैं अपने सहकर्मी के साथ कोड में टिप्पणी प्रारूप (plsql, java) के बारे में चर्चा कर रहा हूं। टिप्पणियों के लिए कोई डिफ़ॉल्ट प्रारूप नहीं है, लेकिन ज्यादातर मामलों में लोग टिप्पणी में ऐसा कुछ करते …

1
पेश है अतिरिक्त स्थानीय चर टिप्पणी प्रतिस्थापन के रूप में
क्या जो हो रहा है उसका वर्णन करने के लिए अतिरिक्त, तकनीकी रूप से शानदार, स्थानीय चर का उपयोग करना अच्छी शैली है? उदाहरण के लिए: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } जब तकनीकी ओवरहेड की बात आती है तो मैं उम्मीद …

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