2010-09-08 4 views
7

मैं नियमित रूप से डेवलपर्स (बड़ी कंपनियों और व्यक्तियों) से उत्पादन कोड देखता हूं जिसमें कोड शामिल किया गया है। संभवतः यह कार्यक्षमता को प्राप्त करने के पहले प्रयासों को हटा देता है जो किसी कारण से काम नहीं करता है।क्या उत्पादन विज्ञप्ति में टिप्पणी-आउट कोड छोड़ने का बुरा अभ्यास

मेरे दिमाग में, यह गन्दा है, लेकिन संभावित रूप से कुछ लाभ हैं उदा। रिफैक्टर पर लौटने या कोड का विस्तार करने पर, डेवलपर देख सकता है कि पहले क्या प्रयास किया गया है।

क्या इस के लिए कोई सुरक्षा या सर्वोत्तम अभ्यास पहलू हैं?

+2

इस प्रकार की चीज़ पहले से कवर की गई है: http://stackoverflow.com/questions/758279/checking-in-of-commented-out-code, http://stackoverflow.com/questions/123423/do- आप-छोड़-ऐतिहासिक-कोड-टिप्पणी-आउट-इन-क्लास-वह-अपडेट-अपडेट – gnovice

+0

धन्यवाद। यह देखकर प्रसन्नता हुई कि जबरदस्त राय इससे छुटकारा पाना है! –

+0

एक और समान प्रश्न https://softwareengineering.stackexchange.com/questions/190096/can-commented-out-code-be-valuable- दस्तावेज –

उत्तर

23

एससीएम का उपयोग करना सर्वोत्तम अभ्यास है। यदि आपको लगता है कि पुराना कोड वास्तव में कुछ लोगों को भविष्य में संदर्भित करना चाहता है, तो "// हम इसे एक और तरीका करते थे, जिसमें दिलचस्प संपत्ति एक्स थी - संशोधन संशोधन 103" पूरे भाग छोड़ने के बजाय कोड जो कुछ भी नहीं करता है।

कोड को टिप्पणी करने के लिए इसकी जगह है, लेकिन वह जगह त्वरित परीक्षण है जो शाखा करने के लिए समय के लायक नहीं है।

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

+1

मुझे किसी विशेष संशोधन का संदर्भ देने वाली टिप्पणी शामिल करने का विचार पसंद है। –

+0

क्या होगा यदि (1) कोई एक एम्बेडेड-सिस्टम कंपाइलर का उपयोग कर रहा है जो अप्रयुक्त तरीकों को अनुकूलित नहीं करता है, और (2) एक के समान कार्यों का एक परिवार होता है (उदाहरण के लिए रखें (हस्ताक्षरित/हस्ताक्षरित) (बाइट/शब्द/लंबा)) , जिनमें से कुछ इस समय उपयोग किया जाता है, और कुछ नहीं। लक्ष्य के ऑर्थोगोनल सेट को आसानी से उपलब्ध कराने के लिए यह वांछनीय प्रतीत होता है, भले ही कुछ # लक्ष्य पर रोम स्थान को सहेजने के लिए बाहर हैं। – supercat

+0

@supercat: यदि यह एससीएम में है, तो यह कुछ # if'd बाहर के रूप में उपलब्ध है। – Chuck

0

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

1

कोड स्रोत नियंत्रण में संग्रहीत किया जाना चाहिए।
टिप्पणियों को समझने में मुश्किल या सामान्य से कुछ करने का कारण समझाने के लिए टिप्पणियां आरक्षित की जानी चाहिए।

संबंधित मुद्दे