क्या हमें अपना संपर्क विवरण स्रोत कोड में छोड़ देना चाहिए?


15

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


7
****** नहीं। ******
जोएल एथरटन

1
@Joel - ****** हेल नं। ****** मुझे कुछ ऐसे कोड याद हैं जिन्हें मैंने दुनिया में फैलाया है और मैं इसे 10 साल बाद याद करने की बजाय इसे भूलने की कोशिश करूंगा। मुझसे डब्ल्यूटीएफ पूछ रहा हूं! = P
jmq

जवाबों:


28

मैं लगभग कभी भी अपना नाम या ई-मेल पता नहीं छोड़ता:

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

इसके बजाय, मैं लोगों को कोड रिपॉजिटरी (SVN, Git, ...) की ओर इशारा करना पसंद करता हूं : वहां, उनके पास पूरा इतिहास हो सकता है - और यह पता लगा सकते हैं कि किस हिस्से के बारे में उनके पास कोई प्रश्न लिखा / संशोधित किया गया है।


6

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

मैं हाल ही में उस आदत से बाहर निकल आया हूं, इस तथ्य को देखते हुए यह संस्करण नियंत्रण के साथ अतिरेक है, उदाहरण के लिए, कोई भी व्यक्ति जो इसमें बदलाव के लिए स्रोत कोड के संपूर्ण इतिहास को देख सकता है।


अहा! उनके डिफ़ॉल्ट टेम्प्लेट्स के बारे में नेटबीन्स से शिकायत करने का समय।
Gio Borje

5

यदि आप पेशेवर रूप से सॉफ़्टवेयर विकसित कर रहे हैं, तो आप शायद कुछ संस्करण नियंत्रण प्रणाली (svn, hg, git, आदि) का उपयोग कर रहे हैं। इस मामले में, मुझे कोड के अंदर आपकी व्यक्तिगत जानकारी छोड़ने के लिए अनावश्यक लगता है क्योंकि आपके पास पहले से ही एक कोडर खाता है (उस जानकारी के साथ) परियोजना पर कोड करने में सक्षम होने के लिए।

हालांकि, खुले स्रोत समुदाय के कुछ लोगों को संपर्क के लिए एक नाम और ईमेल पता छोड़ना दिलचस्प लगता है। यह बिल्कुल भी बुरा विचार नहीं है। इस उदाहरण की जाँच करें:

FFmpeg से:

/*
 * Interplay C93 video decoder
 * Copyright (c) 2007 Anssi Hannula <anssi.hannula@gmail.com>
 *
 * This file is part of FFmpeg.
 */

DirectFB से:

/*
   (c) Copyright 2001-2009  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.
*/

3

लेकिन निश्चित रूप से मेरा नाम और ईमेल छोड़ने का मतलब होगा कि मैं अपने कोड में टिप्पणी लिखने वाला था ?? माफ़ करना जवाब नहीं था। वास्तव में मैं आमतौर पर doctype टिप्पणियों को छोड़ता हूं ...

/**
* @author PurplePilot
* @package
* @etc
*/

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

मेरे पास एक ईमेल sig है जो मैं समय-समय पर उपयोग करता हूं जो जाता है

/* Anything you put in comments is not tested and easily goes out of date. */

जो इस धागे में कई अन्य पदों का एक सामान्य प्रतिबिंब प्रतीत होता है। हालाँकि, इस विषय पर कोई नियम नहीं हैं, एक प्रोग्रामर को वह करने की ज़रूरत है जो उन्हें सबसे अधिक आरामदायक लगे।


इर ... क्या? मुझे लगता है कि यह एक टिप्पणी होनी चाहिए थी।
एडम लेअर

2
@ अन्न - इर्र .... मुझे लगता है कि यह एक मजाक है।
ओसोडो

@Slomojo हाँ, मुझे वह मिल गया। फिर भी लगता है कि यह एक टिप्पणी के रूप में अधिक उपयुक्त है, हालांकि। यह प्यारा है, लेकिन एक गैर जवाब है।
एडम लेअर

@ अन्ना, ओह मैं देखता हूं, शायद, लेकिन यह प्रश्न के उत्तर के रूप में काम करता है, जब मैं इसे पढ़ता हूं।
ओसोडो

2

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

यदि मैंने कंपनी को छोड़ दिया है और कहीं और काम किया है, तो यह मेरे नए नियोक्ता पर वास्तव में उचित नहीं है यदि मैं अपनी आखिरी कंपनी (जो एक प्रतियोगी हो सकता है!) में सॉफ़्टवेयर के बारे में कॉल ले रहा हूं।

यदि कोड किसी अन्य तरीके से साझा किया गया था (उदाहरण के लिए। ओपन-सोर्स, ऑनलाइन पोस्ट किया गया), तो संभवतः यह आपके संपर्क विवरण होने के लायक है, लेकिन यदि कोड किसी अन्य तरीके से पारित किया गया था, तो जिस व्यक्ति को आपने इसे दिया था, वह संभवतः आपके पास पहले से ही होगा संपर्क विवरण, और क्या आप वास्तव में एक बेतरतीब अजनबी को कॉल करना चाहेंगे जो आपके द्वारा वर्षों पहले लिखे गए कोड के बारे में पूछ रहा हो?


एक कंपनी के अंदर हाँ जो समझ में आता है। मैं सार्वजनिक डोमेन में जारी किए गए कोड के बारे में अधिक सोच रहा था।

1
सार्वजनिक रूप से जारी किए गए कोड के लिए, मैं शायद शीर्षलेख में अपना नाम / url / ईमेल लिखूंगा। अगर मैं इसे सार्वजनिक रूप से ऑनलाइन पोस्ट किए जाने के कारण समाप्त हो जाता हूं तो मैं एक अद्वितीय ईमेल उपनाम का उपयोग कर सकता हूं ताकि मैं मेल को फ़िल्टर / ब्लॉक कर सकूं।
डैनी टुप्पेनी

2

विचार की एक पंक्ति है जो कहती है: अपने स्रोत कोड सामान में मत डालो जो स्रोत नियंत्रण में होना चाहिए।

प्रमाणीकरण जानकारी इन चीजों में से एक है, समय के साथ, फ़ाइल ग्रैन्युलैरिटी से कम पर कई लोगों द्वारा कोड को संशोधित किया जाएगा। एक दोष लॉग आपको वह सब कुछ बता देना चाहिए जो आपको जानना चाहिए।

यह कहा जा रहा है, कई कंपनियां मूल फ़ाइल लेखक को सूचीबद्ध करने और इसे कभी नहीं बदलने के संक्रमण का पालन करती हैं। क्या यह वास्तव में उपयोगी है (जैसा कि लोग कंपनियों को छोड़ते हैं), मुझे नहीं पता।

मुझे संदेह है कि मुख्य मूल्य जागरूकता पैदा कर रहा है। आप जाकर आईडीई से यह नहीं पूछेंगे कि आप बताएं कि आपके द्वारा देखी गई प्रत्येक फ़ाइल को किसने लिखा है, लेकिन आपके समूह के कोडबेस में समय के साथ इनका सामना करने से आपको परियोजना में जिम्मेदारियों और विशेषज्ञता का अंदाजा हो जाता है।

सार्वजनिक डोमेन के लिए - लाभ "विज्ञापन" है, नकारात्मक पक्ष यह है कि भविष्य में कोई आपकी फ़ाइल को मिटा सकता है, लेकिन यह अभी भी आपके नाम को प्रभावित करेगा।


2

प्रोग्रामिंग और मेन्टेटिंग और परिवर्तित सॉफ़्टवेयर के 3 दशकों के बाद, मैं सुरक्षित रूप से कह सकता हूं कि स्रोत कोड में लेखक की जानकारी बेकार है।

मेरे पास इसके लिए कभी कोई उपयोग नहीं था। इस पर भरोसा नहीं किया जा सकता। कंपनी द्वारा अभी भी लोगों में से कोई भी कार्यरत नहीं है। आधे नाम ठेकेदार हैं।


2

मैं कोड में अपना संपर्क विवरण कभी नहीं छोड़ता। यह हमेशा पुराना हो जाता है और अधिक समस्या उत्पन्न करने लगता है तब यह हल करता है।

अन्य लोगों ने काफी समस्याओं की ओर इशारा किया है, लेकिन मैं एक उल्लेख करना चाहता था कि मुझे लगता है कि सबसे घातक प्रभाव है।

यह टीम के काम और कोड की गुणवत्ता को नष्ट कर सकता है।

आप कैसे पूछ सकते हैं, अच्छी तरह से यह सब सामूहिक कोड स्वामित्व के साथ करना है। यदि आप अपना नाम कोड रखते हैं, तो आने वाला अगला व्यक्ति यह कहेगा कि "यह मेरा कोड नहीं है, मैं सिर्फ X होगा" जहां X इसे हैक कर सकता है, इसे अनदेखा कर सकता है, आदि। फिर यदि वे इसे ठीक करते हैं, तो वे बेशक वे कोड में अपना नाम डालना चाहते थे क्योंकि उन्होंने इसे सुधार लिया था। लेकिन फिर आप सोच सकते हैं, अरे मैंने इस कोड पर सप्ताह बिताए हैं और उन्होंने 10 मिनट बिताए हैं कि उन्हें मेरा नाम सही से क्यों मिले। समय के साथ यह सिलसिला जारी है और लोग इस बात पर बहस करते हैं कि कोड के लिए किसे क्रेडिट (या दोष) मिलना चाहिए।

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

नोट: यहां तक ​​कि अगर किसी डेवलपर का नाम है, तो भी कॉपीराइट हेडर का यह विनाशकारी प्रभाव हो सकता है, खासकर अगर डेवलपर अन्य योगदानकर्ताओं के रूप में सक्रिय नहीं है। यही कारण है कि ओपन सोर्स प्रोजेक्ट्स पर मैं केवल एक ऑटोहर्स में लेखकों का उल्लेख करने की कोशिश करता हूं या प्रोजेक्ट में एक जगह फाइल करता हूं।


1
मुझे लगता है कि आपके मुद्दे टिप्पणी की तुलना में खराब दिमाग वाले सहकर्मियों से अधिक हैं।
जय

महान उत्तर, कुछ ओपन-सोर्स प्रोजेक्ट भी फाइलों में लेखक की जानकारी लिखने से मना करते हैं क्योंकि यह सामूहिक कोड स्वामित्व को तोड़ रहा है।
.तिने

1

मैं अपनी संपर्क जानकारी को स्रोत कोड में नहीं छोड़ता क्योंकि मेरा VCS मेरे लिए जवाबदेही का ख्याल रखता है।

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

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


1

मैं अपना नाम SQL स्क्रिप्ट में छोड़ देता हूं, क्योंकि वे ज्यादातर डेटाबेस से सीधे प्राप्त किए जाएंगे, स्रोत नियंत्रण से नहीं।

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