एक कार्यक्रम की टिप्पणियों में क्यू एंड ए साइटों के लिए एक लिंक डालना ठीक है?

Question

काफी कुछ कोडबेस में आप चीजों को बताते हुए देख सकते हैं:

 // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade)

इसलिए मुझे कुछ सवाल मिले हैं, लेकिन वे सभी संबंधित हैं।

क्या किसी कार्यक्रम की टिप्पणियों में SO प्रश्नों का लिंक देना ठीक है:

 // We're now mapping from the "sorted-on column" to original indices.
 //
 // There's apparently no easy way to do this in Java, so we're
 // re-inventing a wheel.
 //
 // (see why here, in SO question: http://stackoverflow.com/questions/951848)

क्या आप यह करते हैं?

और ऐसा करने में क्या कमियां हैं? (एक भयानक कमी के लिए मेरी पहली टिप्पणी देखें)

Comments

अपने आप से टिप्पणी करना: एक बहुत ही कमियों के विषय में जब ऐसा करने से एसओ एक विकी होता है, तो बिल्कुल शून्य गारंटी होती है कि आप जिस उत्तर पर भरोसा करते हैं वह अभी भी सही होगा (या अभी भी है)। हेक, कुछ मामलों में प्रश्न को स्वयं बंद किया जा सकता है या अपने मूल अर्थ से बदला जा सकता है। के बीच बड़ा अंतर "बग 1434594 देखें" सूर्य की बग परेड पर है कि आप कर रहे हैं गारंटी है कि सूर्य के बग लिंक से पाठ करेगा नहीं ( "नहीं किया जाएगा" के रूप में RFC2119 द्वारा परिभाषित) परिवर्तन। यह बहुत बड़ा है: यह तथ्य कि एसओ एक विकी है, मुझे टिप्पणियों में एसओ लिंक डालने से परेशान करता है।

— ट्रिस्टन सेंट

आपका सबसे अच्छा शर्त SO उत्तर का एक स्पष्ट और संक्षिप्त सारांश रखना है , और फिर उसके नीचे संदर्भ लिंक रखना है। मैंने ऐसा कई बार किया है। इस प्रकार, यदि SO कभी भी नीचे जाता है या उत्तर हटा दिया जाता है / संपादित किया जाता है, तो आपके द्वारा वांछित मूल जानकारी अभी भी आपके सारांश में है। अब, उत्तर की जटिलता के आधार पर, सारांश लिखना एक पूरी तरह से अलग काम हो सकता है। यदि SO उत्तर किसी और चीज़ से लिंक करता है, तो यह उन लोगों से लिंक करने के लिए योग्य हो सकता है (विशेषकर यदि वे SO उत्तर से कम अल्पकालिक हैं)।

— FrustratedWithFormsDesigner

@ रॉबर्ट एस .: नहीं, यह एक मेटा नहीं है। यह एसओ के बारे में नहीं है: मैं एसओ को वैसे ही स्वीकार कर रहा हूं। यह विशेष रूप से एक टिप्पणी से एसओ जैसे संसाधन से निपटने के बारे में है।

— ट्रिस्टन सेंट

क्या आप उस कोड के बारे में बात कर रहे हैं जो आप अपनी टीम के लिए लिखते हैं? उनसे पूछों।

आप हमेशा पूरे वेब पेज को एक पूर्ण वेब पेज के रूप में सहेज सकते हैं, इसे ज़िप कर सकते हैं और इसे अपने वृत्तचित्र फ़ोल्डर में रख सकते हैं।

Answer 1

मैंने इसे किया है, शायद विशेष रूप से स्टैक ओवरफ्लो के लिए नहीं, लेकिन तकनीकी ब्लॉग, फ़ोरम, यूज़नेट, Google समूह, या किसी अन्य स्थान के लिए जहां "मैंने ऐसा क्यों किया" संदर्भ से पूरी तरह से स्पष्ट नहीं हो सकता है।

मैं यह नहीं देखता कि एसओ का उपयोग करना क्यों एक बुरी बात होगी, जब तक कि वे पुराने प्रश्नों को संग्रहीत और शुद्ध नहीं कर देते (जो मुझे नहीं लगता कि वे करते हैं, लेकिन मुझे यकीन नहीं है) - लेकिन भले ही वे करते हैं, यह नहीं है किसी भी अन्य साइट से भी बदतर है।

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

Answer 2

आमतौर पर, इस लिंक को बनाने का सबसे अच्छा तरीका वर्जनिंग सिस्टम और / या बग ट्रैकिंग सिस्टम है। इसके लिए काम करने की आवश्यकता हालांकि यह है कि आप अपने कोड को बग ट्रैकर या संस्करण प्रणाली में उस स्थान से जोड़ सकते हैं जहां आपने अपनी टिप्पणी दी है।

Comments

यह दिलचस्प है: तो आप वास्तव में सुझाव दे रहे हैं कि एसओ उत्तर के मामले में मैं एचटीएमएल ला सकता हूं और इसे अपने डीवीसीएस (मर्क्यूरियल में स्टोर कर सकता हूं लेकिन यह बात नहीं है)?

— ट्रिस्टन सेंट

ठीक है, आम तौर पर आपको पूरी बात की जरूरत नहीं है, बस प्रासंगिक बिट्स सही है? और आप स्रोत का संदर्भ ले सकते हैं।

Answer 3

आदर्श रूप से आपके कोड को इस तरह की टिप्पणियों की आवश्यकता नहीं है क्योंकि यह अच्छी तरह से संरचित है, लेकिन हां, जब आपकी स्थिति आदर्श से कम है, तो यह इस तरह की टिप्पणियों में डालने के लिए स्वीकार्य है। और stackoverflow.com के लिंक दूसरों की तुलना में अच्छे (और अक्सर बेहतर!) हैं।

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

मैंने अभी तक अपने कोड में एक StackOverflow.com लिंक नहीं डाला है। मैं कोड में लिंक डालने से बचने की कोशिश करता हूं, क्योंकि यह एक बुरी गंध है, लेकिन जब समय आता है तो मैं संकोच नहीं करूंगा।

संपादित करें : मुझे लगता है कि मेरा उपरोक्त उत्तर यह धारणा देता है कि इस तरह की टिप्पणियों की आवश्यकता टालने योग्य है। बेशक कभी-कभी यह परिहार्य नहीं है ; यह लाइब्रेरी या खराब एपीआई डिज़ाइन में एक बग है जिसका आपके पास कोई नियंत्रण नहीं है। इस तरह की टिप्पणियाँ, लिंक सहित, अगले डेवलपर के साथ आने के लिए बहुत उपयोगी है।

Comments

हे, उस एक को देखो, मैं चाहता हूं कि इससे निपटने के लिए एक "क्लीनर" तरीका होगा, लेकिन बहुत बार ऐसा नहीं होता है stackoverflow.com/questions/951848 मेरा मतलब है, कीड़े और असंगतता / अजीब एपीआई, अनैच्छिक व्यवहार आदि। हमारे प्रोग्रामर लिफ्टों का हिस्सा हैं :)

— ट्रिस्टन सेंट

Answer 4

मैं इसे शोध पत्र लिखने की तरह देखता हूं। अगर मैं किसी और के विचारों का उपयोग करता हूं, तो मुझे उन विचारों का श्रेय देने की जरूरत है। मैंने पहले भी अपने कोड में स्टैकओवरफ़्लो से एक उत्तर का उपयोग किया है, और मैंने विधि की टिप्पणियों के लिए लिंक जोड़ा।

जैसा कि किसी ने उल्लेख किया है, एसओ एक विकी शैली है, इसलिए यह संभव है कि यह बदल सकता है, लेकिन आम तौर पर विचार अभी भी समान होना चाहिए।

जब आप उनके विचारों का उपयोग करते हैं तब भी आपको दूसरों को श्रेय देना चाहिए।

Answer 5

यदि आपको किसी कार्य को लागू करने की आवश्यकता है, और यह स्पष्ट नहीं है कि कार्यान्वयन एक विशेष तरीके से क्यों किया गया है, तो एक टिप्पणी को वास्तव में कारणों की पहचान करने की अनुमति दी जानी चाहिए। मुझे लगता है कि एक ऑनलाइन संदर्भ के लिए लिंक देना ठीक है, लेकिन आपको वास्तव में अपनी टिप्पणी को पर्याप्त बनाने की आवश्यकता है, फिर भी पर्याप्त है कि लिंक केवल एक विस्तारित विवरण प्रदान करेगा पाठक को आपके तर्क की दोहरी जांच करने की आवश्यकता महसूस होनी चाहिए।

यदि दूसरी ओर कोड को शब्दशः कॉपी किया गया है, तो मूल स्रोत के लिए एक लिंक केवल उचित है, और लाइसेंस के शब्दों के आधार पर आवश्यक हो सकता है जिसके तहत आपको मूल लेखक के काम की प्रतिलिपि बनाने की अनुमति दी गई है।