नामकरण को अत्यधिक जटिल बनाने से अराजकता फैलती है

टीएल;डीआर: नामकरण कठिन है, अनावश्यक आकस्मिक जटिलता के साथ इसे कठिन न बनाएं।

समस्याएँ

• अस्पष्ट, भ्रामक, अस्पष्ट और अस्पष्ट नाम

• अनावश्यक शब्दावली

• भ्रमित अमूर्तताएं

• गुप्त संक्षिप्ताक्षर

समाधान

1. नामकरण परंपराओं को सरल बनाएं

2. स्थिरता सुनिश्चित करें

3. अनावश्यक शब्दजाल से बचें

4. व्यवहार के आधार पर वर्णनात्मक नामों का उपयोग करें

5. सुसंगत शब्दावली बनाए रखें

प्रसंग

लुडविग विट्गेन्स्टाइन ने तर्क दिया कि भाषा के दुरुपयोग से बहुत भ्रम पैदा होता है।

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

जब आप स्पष्टता के बिना कक्षाओं, विधियों, या चर का नाम देते हैं, तो आप एक भाषाई भूलभुलैया बनाते हैं जिसे दूसरों को नेविगेट करने में कठिनाई होती है।

इससे बग उत्पन्न होते हैं, रखरखाव कठिन हो जाता है, और टीम को निराशा होती है।

नमूना कोड

गलत

public class AbstractDataHandlerManager {
    private String dtStr;

    public void execProcessingOps(String input) {
        if (dtStr != null && !dtStr.isEmpty()) {
            // process
        }
    }
}

सही

public class SETIProcessor {

    public void processSignal(String input) {      
            // process
        }
    }
}

खोज

[X] मैनुअल

आप इस गंध का पता तब लगा सकते हैं जब नाम लंबे होने लगते हैं, या जब आप "सार", "प्रबंधक," "हैंडलर," "सहायक", या "डेटा" बहुत बार देखते हैं।

एक अन्य संकेत यह है कि आपको यह समझाना होगा कि कोड समीक्षा में उदाहरण के लिए अन्य डेवलपर्स के लिए एक नाम का क्या अर्थ है।

टैग

• नामकरण

स्तर

[X] शुरुआती

एआई पीढ़ी

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

वे कई डोमेन के विशेषज्ञ हैं और कोड लिखते हैं, लेकिन अक्सर वे निर्देश दिए जाने तक दोनों काम एक साथ नहीं करते हैं।

एआई डिटेक्शन

एआई जनरेटर कभी-कभी "नामों को सरल बनाएं" या "अनावश्यक शब्दों को हटा दें" जैसे सरल रीफैक्टरिंग निर्देशों के साथ इस गंध को ठीक कर सकते हैं, लेकिन गहरी प्रासंगिक समझ के साथ संघर्ष करते हैं।

निष्कर्ष

कोड में भाषाई भ्रम अनावश्यक जटिलता को जन्म देता है।

अपने कोड को पढ़ने और बनाए रखने में आसान बनाने के लिए स्पष्ट, सुसंगत और सीधे नामकरण का उपयोग करें।

संबंध

कोड गंध 22 - सहायक

मैक्सी कॉन्टिएरी ・ नवंबर 12 '20

#उफ़ #मददगार #कोडनौसिखिया #शुरुआती

कोड गंध 38 - सार नाम

मैक्सी कॉन्टिएरी ・ नवंबर 30 '20

#उफ़ #कोडनौसिखिया #नामकरण #वेबदेव

कोड गंध 197 - अनावश्यक संदर्भ

मैक्सी कॉन्टिएरी ・ फ़रवरी 21 '23

#वेबदेव #शुरुआती #प्रोग्रामिंग #ट्यूटोरियल

कोड गंध 113 - डेटा नामकरण

मैक्सी कॉन्टिएरी ・ जनवरी 5 '22

#उफ़ #वेबदेव #डेटाबेस #रिफैक्टरिंग

और जानकारी

विट्गेन्स्टाइन की भाषाई भ्रम की अवधारणा

सॉफ्टवेयर क्या है (गलत)

मैक्सी कॉन्टिएरी ・ अक्टूबर 8 '20

#उफ़ #ठोस #शुरुआती #डिज़ाइन

वास्तव में नाम क्या है? — भाग I: खोज

मैक्सी कॉन्टिएरी ・ फ़रवरी 9 '21

#कोडनौसिखिया #ट्यूटोरियल #वेबदेव #उफ़

वास्तव में नाम क्या है - भाग II पुनर्वास

मैक्सी कॉन्टिएरी ・ 23 मई '21

#ट्यूटोरियल #कोडनौसिखिया #प्रोग्रामिंग #वेबदेव

अस्वीकरण

कोड गंध मेरी राय है।

क्रेडिट

अनस्प्लैश पर मिमी थियान द्वारा फोटो

स्पष्ट भाषा का सबसे बड़ा दुश्मन निष्ठाहीनता है।

जॉर्ज ऑरवेल

सॉफ्टवेयर इंजीनियरिंग महान उद्धरण

मैक्सी कॉन्टिएरी ・ दिसंबर 28 '20

#कोडनौसिखिया #प्रोग्रामिंग #उद्धरण #सॉफ़्टवेयर

यह लेख कोडस्मेल श्रृंखला का हिस्सा है।

अपने कोड के बदबूदार हिस्सों को कैसे खोजें

मैक्सी कॉन्टिएरी ・ 21 मई '21

#कोडनौसिखिया #ट्यूटोरियल #कोड गुणवत्ता #शुरुआती