"मजाकिया टिप्पणी" एक बुरा अभ्यास है या नहीं? [बन्द है]

Question

मैं आपसे पूछना चाहता हूं कि क्या सोर्स डॉक्यूमेंटेशन में कुछ "ईस्टर अंडे" जोड़ना अनप्रोफेशनल है या नहीं। शायद आप पढ़ा है StackOverflow एक स्रोत दस्तावेज में अजीब टिप्पणी के लिए चुनाव, और मैं व्यक्तिगत रूप से कई ऐसी बातें पर मेरे काम के दौरान (नहीं या) सार्वजनिक API दस्तावेज़ों में (उदाहरण के लिए इस कमजोर ठोकर खाई है, मजाकिया सहित सामान BZZZTT !! 1! बात Android सार्वजनिक प्रलेखन में, मैं कम से कम एक दर्जन से अधिक उदाहरण दे सकता हूं)।

मैं अपने लिए अंतिम राय नहीं दे सकता, क्योंकि मेरे पास खुद के तर्क का विरोध है।

प्रो तर्क:

• यह किसी को खुश कर सकता है, और उसके / उसके दिन को मजेदार / अधिक उत्पादक बना सकता है। स्रोत कोड के प्रमुख भाग को वैसे भी टिप्पणी करने की आवश्यकता नहीं है (यदि परियोजना ठीक से की गई है), क्योंकि विशिष्ट विधि (उदाहरण के लिए) स्व व्याख्यात्मक है, या यदि यह अजीब गंदे कोड का ढेर है, तो यह नहीं हो सकता है एक सार्थक तरीके से समझाया जा सकता है, इसलिए एक अजीब मजाक संभव जानकारी को नुकसान नहीं पहुंचाता है जिसे आप डॉक्टर से प्राप्त कर सकते हैं।

विपक्ष तर्क:

• यदि आप बहुत एकाग्र / निराश हैं, तो आपको जिस अंतिम चीज़ की ज़रूरत है, वह किसी का बेवकूफाना मज़ाक है, इसके बजाय आपको दस्तावेज़ कोड भाग के बारे में आवश्यक जानकारी देने के बजाय, यह आपको और भी निराश कर सकता है। और इस बात का अंदाजा लगाया जाए कि अगर हर कोई ऐसा करना शुरू कर दे तो प्रलेखन कैसा लगेगा। इसके अलावा, जो व्यक्ति मजाक लिखता है वह केवल वही हो सकता है जो सोचता है कि यह पढ़ने के लिए अजीब / दिलचस्प / बेकार समय है।

तुम क्या सोचते हो?

Comments

प्रश्न पूछने के लिए कृपया साइट के अक्सर पूछे जाने वाले प्रश्न और दिशानिर्देश पढ़ें। यह प्रश्न वास्तव में उन दिशानिर्देशों को पूरा नहीं करता है।

— वाल्टर

@Walter: यह प्रोग्रामर के रूप में बहुत ही सवाल है ।stackexchange.com/questions/50928/ …, लेकिन अपवित्र टिप्पणियों के बजाय मजेदार टिप्पणियों के लिए, और लिंक किए गए प्रश्न को बंद नहीं किया गया है, एक महीने पहले पूछा गया था। मैं आपके साथ बहस करने में समय बर्बाद नहीं करूंगा कि यह प्रश्न एफएक्यू से मिलता है, और यह कोड लिखते समय सर्वोत्तम (अच्छी) प्रथाओं से संबंधित है।

— किसी ने

7 वोट, यह क्यू स्पष्ट रूप से चाहता है। व्यक्तिगत रूप से मुझे नहीं लगता कि मुझे आपके द्वारा कई बार उल्लेखित "कोन" द्वारा पेशाब किया गया है, लेकिन मैं "प्रो" के तर्कों को देख सकता हूं इसलिए मैं उत्सुक हूं कि परिणाम क्या है। (सबसे खराब बात यह है कि मैं btw का सामना करने वाला एक प्रोग्रामर था जिसने सोचा था कि बीबी बंदूक की एक "प्रफुल्लित करने वाली" तस्वीर एक बिल्ली के बच्चे की ओर इशारा करती है, जिसके पंजे ऊपर हैं, यह हमारे सभी देव सर्वर के होम पेज पर होना चाहिए। आहें ...)

— जेम्स

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

— जेएफओ

मैं इस बात से सहमत हूं कि इस पोस्ट को फिर से खोला जाना चाहिए, हालांकि मैं वोट नहीं दे सकता क्योंकि मेरे पास प्रतिनिधि नहीं है। प्रोग्रामर को SO से अलग करने का पूरा बिंदु इस तरह के प्रश्नों के लिए है। इस प्रश्न के लिए 22 वोटों के साथ, यह समुदाय द्वारा स्पष्ट रूप से वांछित है।

— रोबोशॉप

Answer 1

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

लेकिन ... कोई भी वास्तव में हर दिन 100% काम नहीं करता है (अगर हम ऐसा करते हैं तो साइटें खाली हो जाएंगी) और वास्तविक हास्य दिन को तोड़ देता है और मनोबल बनाए रखने में मदद करता है।

मैं अभी भी इसके खिलाफ सिर्फ इसलिए वोट करूंगा क्योंकि मैंने जो भी 'मज़ेदार' टिप्पणी कभी-कभी पढ़ी है, वह उस समय बहुत अच्छा लगा होगा - लेकिन मैंने अभी तक ऐसा नहीं देखा है, जो वास्तव में मज़ेदार हो, ज़्यादातर महज़ हैरान करने वाला हो या किसी गहरेपन में हो। -मज़ाक।

यदि वास्तव में मजाकिया टिप्पणियां मजाकिया होतीं तो इससे मेरा मन बदल जाता। लेकिन एक बार जब आप चुटकुले को प्रोत्साहित करते हैं, तो क्या आप शपथ या अपमान या दुर्भावना को प्रोत्साहित करते हैं?

Comments

+1 आप केवल उन टिप्पणियों को पढ़ते हैं जब आपको कुछ ठीक करना होता है और उन्हें तब कोई मतलब नहीं होता है और जब आप उपसर्ग करते हैं तो निश्चित रूप से विषय के बारे में कुछ अन्य डेवलपर के 'चतुर मजाक' को देखने के मूड में नहीं होते हैं। मजाक के बारे में सोचने पर समय बिताने के बजाय, कृपया स्पष्ट कोड पर कुछ समय बिताएं, एक बग को ठीक करें, आदि। इसके अलावा, अगर कुछ का रिफैक्ट हो गया तो 'मजाक' के साथ क्या होता है?

— Jan_V

तो यह सिर्फ मीटस्पेस में हास्य की तरह है: यह बेहतर मजाकिया है, और यह बेहतर नहीं है कि आप सभी करें।

— डैन रे

+1 चतुर, जब तक यह कोई नुकसान नहीं पहुंचाता। stop() //hammertimeरोक के हर उदाहरण पर डाल अजीब नहीं है।

— glasnt

@glasnt - यह वास्तव में एक अजीब टिप्पणी है - लेकिन यह पुनरावृत्ति 2 पर जलन करेगा, और बाद में तेजी से जलन करेगा!

— अमेल्विन

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

— जेबेक

Answer 2

मैं मजाकिया टिप्पणी का बहुत बड़ा प्रशंसक हूं ।

आपको हमेशा अपनी टिप्पणी में पेशेवर होना चाहिए, लेकिन कुछ हास्य पाठक को नहीं मारेंगे।

खासकर अगर पाठक आपकी टीम का सदस्य हो।

जो चीज़ मुझे सबसे ज़्यादा नापसंद है, वह है डेवलपर्स जो खुद को बहुत गंभीरता से लेते हैं। मुझे लगता है कि हमें काम करने में मज़ा आना चाहिए, या काम इसके लायक नहीं है।

Comments

+1 के लिए "व्यावसायिक लेकिन मजेदार"

— डेवॉर्ड

प्रोग्रामिंग खुद ही मज़ेदार है :)

— गोपी

@ श्री कुमार: दुर्भाग्य से, हमेशा नहीं। :(

— बॉबी

@ बॉबी: इसे मज़ेदार बनाने का फ़ैसला लो! यदि वे आपको ऐसा नहीं करने देंगे, तो अपनी खुशी किसी ऐसी कंपनी में पहुंचाएं जो इसके लायक हो।

अपने आप को बहुत गंभीरता से नहीं लेने के लिए +1।

— जेफ़ओ

Answer 3

यदि इसका अर्थ है, तो मजाकिया होना ठीक है। कमेंट में मनोरंजक तरीके से कुछ बताना ठीक है। हालांकि, अगर यह केवल कुछ मज़ेदार है और इसमें टिप्पणी के रूप में कोई वास्तविक मूल्य नहीं है, तो बस गुस्सा आता है। हमेशा ध्यान रखें कि टिप्पणियों का कारण रखरखाव को अधिक कुशल बनाना है। हास्य के साथ संघर्ष नहीं करना पड़ता है, लेकिन अगर उचित तरीके से नहीं किया जा सकता है।

Comments

एक महत्वपूर्ण प्रोग्राम के एरर हैंडलिंग कोड में एक टिप्पणी है: "Life's a _ और फिर आप मर जाते हैं।" स्पष्टीकरण के अंत में। यह मजेदार है और यह समझ में आता है।

— माइकल के

@ मिचेल - यह एक आदर्श उदाहरण है जो मुझे लगता है कि एक बेकार है। यह मज़ेदार नहीं है (बहुत पुराने और थके हुए बयान का एक और दोहराव होना) और मूल्य का कुछ भी नहीं जोड़ता है।

— ब्रायन नोब्लुक

Answer 4

कोड पढ़ने के लिए है ... कई बार।

आप कितने चुटकुलों को जानते हैं जो सौवें बताने के बाद मजाकिया हैं?

Comments

@ Thorbjørn Ravn Andersen: दिल्बर्ट कार्टून के बारे में क्या आप प्रिंट करते हैं और अपने क्यूबिकल वॉल पर पिन करते हैं? ;)

@ पियरे, अगर आपको एक स्रोत कोड टिप्पणी में डालने के लिए एक ही दिलबर्ट उपयुक्त लगता है, तो कृपया मुझे बताएं।

@ Thorbjørn रावन एंडरसन: दिलबर्ट

@ पियरे, वास्तव में मैं उस पोस्टर में सीमा से अधिक शब्द को मजाकिया मानता हूं और मजाकिया नहीं, लेकिन यह एक और मामला है। आपके पास और कितने हैं?

@ Thorbjørn रावन एंडरसन: वह केवल एक ही है

Answer 5

मजेदार टिप्पणियां बहुत अच्छी हैं।

• यह आपके प्रतीत होता है उबाऊ कोड के लिए एक सकारात्मक खिंचाव देता है।
• यदि आप अपने समय को सही ढंग से प्राप्त करते हैं । यह सामान्य उबाऊ टिप्पणी की तुलना में बहुत बेहतर व्याख्या करता है। यहाँ 'टाइमिंग' से मेरा मतलब टिप्पणी के नीचे दिए गए कोड से प्रासंगिकता से है।
• आपका कोड कई लोगों द्वारा याद किया जाएगा, क्योंकि भावनाओं को (मानव) स्मृति में बेहतर स्थान दिया जाता है। यदि आप अधिक लोगों को अपने साथ एक ओपन-सोर्स प्रोजेक्ट पर काम करना चाहते हैं तो यह एक शानदार ट्रिक है।
• आम तौर पर समीक्षाओं में मददगार। यह आपके कोड को और अधिक प्रभावी बनाता है। बेशक आपको पहले अच्छे कोड लिखने पर ध्यान देना चाहिए। मुझे लगता है कि जब कोई अपने लिखे गए कोड के साथ आश्वस्त होता है, तो मजेदार टिप्पणियां सिर्फ एक साइड इफेक्ट होती हैं।

बस इस आदमी की तरह मजाकिया मत बनो ;)

Answer 6

यहाँ मैंने सुबह दो बजे लिखा है ("DQ" मेरी कंपनी के शुरुआती अक्षर हैं):

// Twas the night before go-live and all through DQ
// the devs were all crying and yes, this means you.
// Keys had been saved with both hyphens and 'scores
// which left this programmer with finger pad sores.
// The solution I crafted, you'll likely find lacking:
// to OR them together with judicuous hacking.

$hyphenated = str_replace('_','-',$data_type_key);
$underscored = str_replace('-','_',$data_type_key);
// (and then see line 46)

Comments

हां, इस तरह की चीजें 2 बजे होने की संभावना है, लेकिन मैं यह नहीं कहता कि यह एक अच्छा मजाक है - किसी को आपके पाठ की 6 पंक्तियों को पढ़ने के बाद अगर वह स्रोत की 2 पंक्तियों के लिए टिप्पणी देखना चाहता है। निबंध की 600 पंक्तियों को पढ़ने के लिए समान अनुपात जो कोड की 200 पंक्तियों को समझाता है

— कोई व्यक्ति

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

— डैन रे

उस स्थिति में मैं बहुत प्रसन्न

— किसी ने

लाइन नंबर न डालें, "जहाँ भी <टिप्पणी करें" के बजाय "जो कुछ भी हो" का उपयोग करें।

— विंको वर्सालोविच

Answer 7

यदि आप ग्राहक के सामने अपने स्रोत कोड की समीक्षा कर रहे थे तो क्या आप शर्मिंदा होंगे?

वर्तमान उत्तरों में से कोई भी इसे ध्यान में नहीं लगता है। कुछ ग्राहकों में हास्य की कोई भावना नहीं है और चुटकुले को एक संकेतक के रूप में लेंगे कि आप अपनी नौकरी को गंभीरता से नहीं लेते हैं। वे अनुमान लगाएंगे कि आप अपने काम के प्रति लापरवाह हैं।

मजेदार कोड टिप्पणियां कभी-कभी अव्यवसायिक और अनुचित हो सकती हैं।

Answer 8

परे जो पहले से ही कहा गया है, यदि आप अंतरराष्ट्रीय टीम में काम कर रहे हैं, तो आपके कुछ विदेशी सहयोगियों को मजाक नहीं मिल सकता है, क्योंकि कुछ स्थानीय सांस्कृतिक संदर्भों में से कुछ या कुछ ऐसे शब्द जो किसी के द्वारा समझ में नहीं आते हैं जिनके लिए अंग्रेजी मूल भाषा नहीं है । ओपन सोर्स प्रोजेक्ट्स के लिए भी यही बात लागू होती है।

Answer 9

यदि यह कुशल है और पाठकों के समय (या तो पढ़ने / समझने में) को बर्बाद नहीं करता है तो मुझे थोड़ी परेशानी नहीं होती है।

Answer 10

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

Answer 11

निर्भर करता है, कॉलेज में असाइनमेंट के लिए, मैं लगभग हमेशा अजीब टिप्पणी कर रहा था, जैसा कि मुझे पता था कि इसका उपयोग कभी नहीं किया जाएगा और यह सिर्फ एक होमवर्क असाइनमेंट है।

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

मुझे याद है कि मैं वेब प्रोग्रामिंग का एक सा काम कर रहा था, जहाँ मुझे ब्राउज़र की असंगतताओं और अजीब गड़बड़ियों को चकमा देना था। यह कभी-कभी .jsफाइलों में गुस्से और नफ़रत से भरी टिप्पणियों में समाप्त हो जाता है ।

मेरे अंगूठे का मूल नियम है: यदि यह कुछ स्पष्ट है कि कोड अनुभाग क्या करता है, तो FUNNY टिप्पणियाँ TURN ON!

यदि कोड इतना अस्पष्ट है और नरक के रूप में अस्पष्ट है (" इनलाइन क्लास " की तरह), तो मैं बेहतर तरीके से उन टिप्पणियों का उपयोग करूंगा जो मैं खुद को कुछ दिनों में समझूंगा ...