इसे धीरे से हतोत्साहित किया जाना चाहिए
..आपको शायद पता नहीं है कि इसके 'जीवनकाल' के स्रोत कोड को देखने के लिए कौन मिलेगा।
हालांकि यह विशेष रूप से जटिल या पुराने टुकड़े के कोड से निराश होने के लिए नौकरी का हिस्सा है और इसके बारे में ध्वनि करना चाहता है, स्रोत कोड में एक्सप्लेटिव / रेंट / एएससीआईआई कला / खराब चुटकुले / आपत्तिजनक टिप्पणी दोनों लगाना अव्यवसायिक और एक है मेरे अनुभव में बुरा विचार है। कभी-कभी, टिप्पणियों को लिखने वाला इंजीनियर अपनी टिप्पणियों के संभावित प्रभावों से बेखबर होता है - यहाँ मेरे द्वारा देखे गए कुछ मुद्दे हैं:
- खुले स्रोत / नमूना कोड के रूप में जनता को जारी किए गए कोड में उच्च संख्या में छूट।
- खराब स्वाद में चुटकुले कुछ टीम के सदस्यों के लिए गहरी चोट का कारण बन गए जिसके परिणामस्वरूप औद्योगिक न्यायाधिकरण बना।
- थ्रो-दूर की टिप्पणी जो वास्तव में नस्लवादी / सेक्सिस्ट / लिंग-आईएसटी थी जिससे लोग निकाल दिए गए थे।
जबकि हम सभी को हताशा / मौज-मस्ती के लिए कुछ आउटलेट्स की आवश्यकता होती है, लेकिन स्रोत कोड ऐसा करने का स्थान नहीं है, IMO। आप अनुबंध, सहायता पृष्ठ, ब्लूप्रिंट, या अन्य पेशेवर दस्तावेज़ों में एक्सप्लेटिव / चुटकुले / आपत्तिजनक टिप्पणी नहीं डालेंगे, भले ही उन दस्तावेजों को स्रोत कोड से कम बार भी पढ़ा जा सकता है।
अगर टीम के नेता इसके बारे में सभी भारी-भरकम हो जाते हैं, तो परेशान होने वाले हैं, इसलिए मैं कहता हूं कि समस्या इंजीनियरों के साथ एक शांत शब्द के माध्यम से 'धीरे से हतोत्साहित' किया जाता है और स्टीम को बंद करने के लिए उपयुक्त वेंटिंग तंत्र प्रदान किया है, चाहे वह फेसबुक हो, इंस्टैंट मैसेजिंग , एयर हॉकी या पंच-बैग।
यह कहना कोई बचाव नहीं है कि टिप्पणियों का संकलन या तो किया जाता है - जावास्क्रिप्ट, या किसी अन्य गतिशील क्लाइंट-साइड कोड के बारे में क्या?
यहाँ कुछ वास्तविक दुनिया के अनुभव हैं जिन्हें मैंने अपनी राय दी है:
Microsoft में काम करते हुए, मैंने देखा कि एक सॉफ्टवेयर इंजीनियर को "नहीं" की सही वर्तनी का पता नहीं था - उसने ओ, एल और डी को याद किया - और अपने कोड की बहुत सारी व्याख्याएँ की, जिसमें वह यह नहीं बता सकता था। काम करने के लिए X प्राप्त करें क्योंकि Y व्यक्ति को समस्या हो रही थी Z। उसका कोड बहुत अच्छा था; उसकी वर्तनी इतनी अच्छी नहीं थी। कहने के लिए पर्याप्त, इस कोड के किसी भी बाद के समीक्षक (जैसे मुझे) कोड में बड़ी संख्या में यादृच्छिक शपथ देखने के लिए चिंतित थे। इस कोड में से कुछ को भागीदारों (ड्राइवर लेखकों) को दिखाया गया था। कसम से देखकर उनकी डरावनी कल्पना कीजिए। रैंट आदर्श रूप से मौखिक रूप से परियोजना प्रबंधक के पास होना चाहिए (जिस स्थिति में व्यक्ति Y चर्चा के लिए खींचा जा सकता है) या शायद संदेश दे सकता है, लेकिन स्रोत में नहीं।
एक कंपनी में, एक विदेशी भाषा बोलने वाला व्यक्ति मुख्य रूप से अंग्रेजी बोलने वाली टीम में शामिल हो गया। उन्होंने अपनी भाषा में टिप्पणी करते हुए लिखा कि कोई और उन्हें नहीं पढ़ सकता है। यह ठीक था, जब तक कि बबलफिश / गूगल ट्रांसलेट ने अपनी भाषा के लिए एक 'इंग्लिश' विकल्प जारी नहीं किया, जिस बिंदु पर टीम के बाकी सदस्यों ने कुछ टिप्पणियों का अनुवाद किया और उन्हें गंदी और अक्सर अपमानजनक टिप्पणियों पर सराहा गया, जो कंपनी के बारे में लोग कर रहे थे। , उनकी टीम और एक महिला सहकर्मी। अजीब बात है ।
किसी अन्य कंपनी में, एक व्यक्ति को वास्तव में ASCII कला के साथ लिया गया था और सभी प्रकार की कलाओं को अपने स्रोत कोड में डाल दिया, कोड समीक्षकों द्वारा अनिर्दिष्ट (या शायद धन्य)। थोड़ी देर के बाद, वह किसी कारण से, आमतौर पर किसी प्रकार की टैग लाइन के साथ ड्रेगन पर रहता था। बाद में, एक वेल्श व्यक्ति टीम में शामिल हो गया। वेल्स का राष्ट्रीय प्रतीक एक लाल ड्रैगन है, इसलिए नए आदमी को शुरुआत में चित्रों के बारे में खुश था, लेकिन तब नाराज हो गया जब कुछ मूर्खतापूर्ण टैग लाइनों को आक्रामक के रूप में माना जा सकता था। हां, कुछ टीम लीडर की मध्यस्थता आवश्यक है, लेकिन ऐसा नहीं होना चाहिए था।
निर्दोषों की रक्षा के लिए नाम / बारीकियों को हटाया गया।