] यह काम करता है ... मुश्किल से। लेकिन इसे बनाए रखना? यह एक बुरा सपना है।

] अपने कोड को साफ, पठनीय और भविष्य-प्रूफ रखने के लिए यहां कुछ सरल नियम दिए गए हैं।

गंदे कोड क्या है? गंदा कोड कोड है कि:

पढ़ना या समझना मुश्किल है।

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

• यह अक्सर तब होता है जब डेवलपर्स:
तंग समय सीमा के तहत काम करें।
कोड समीक्षाएँ छोड़ें।

सर्वोत्तम प्रथाओं या मानकों का पालन न करें।

]
1. ]
बनाए रखने के लिए महंगा: खराब लिखित कोड में सुधार होने में अधिक समय लगता है।
2. टीम भ्रम: नए डेवलपर्स अतिरिक्त घंटे बिताते हैं बस यह समझने की कोशिश कर रहे हैं कि क्या हो रहा है। गंदे कोड को आज काम मिल सकता है, लेकिन यह आपकी टीम और भविष्य के लिए एक टिक टाइम बम है।

गंदे कोड से बचने के लिए सरल नियम

1। एकल जिम्मेदारी सिद्धांत (SRP)

का पालन करें प्रत्येक फ़ंक्शन, विधि या वर्ग को केवल एक ही काम करना चाहिए। यदि आप अपने आप को बहुत अधिक जिम्मेदारियों के साथ लिखते हुए तरीके पाते हैं, तो उन्हें छोटी इकाइयों में तोड़ दें।
❌ बुरा उदाहरण:
• def process_user_data (उपयोगकर्ता): उपयोगकर्ता ['आयु'] = उपयोगकर्ता ['आयु'] 1 db.save (उपयोगकर्ता) प्रिंट (f "उपयोगकर्ता {उपयोगकर्ता ['नाम']} अद्यतन")

✅ अच्छा उदाहरण:

] उपयोगकर्ता ['आयु'] = 1 def save_user_to_db (उपयोगकर्ता): db.save (उपयोगकर्ता) def log_user_update (उपयोगकर्ता): प्रिंट (f "उपयोगकर्ता {उपयोगकर्ता ['नाम']} अद्यतन") ]

२। जादू की संख्या और तार से बचें हार्ड-कोडेड मान ("मैजिक नंबर") कोड को अपठनीय और बनाए रखने के लिए कठिन बनाते हैं। इसके बजाय स्थिरांक का उपयोग करें।

❌ बुरा उदाहरण:

अगर (StatusCode === 404) { कंसोल.लॉग ("नहीं मिला"); }

def process_user_data(user):
    user['age'] = user['age']   1  
    db.save(user)  
    print(f"User {user['name']} updated")  

✅ अच्छा उदाहरण:

const not_found = 404; if (StatusCode === not_found) { कंसोल.लॉग ("नहीं मिला"); }

def update_user_age(user):
    user['age']  = 1  

def save_user_to_db(user):
    db.save(user)  

def log_user_update(user):
    print(f"User {user['name']} updated")  

३। वर्णनात्मक चर और फ़ंक्शन नाम लिखें

आपके चर नामों को प्रतिबिंबित करना चाहिए कि वे क्या प्रतिनिधित्व करते हैं। संक्षिप्त और गुप्त नामों से बचें। ❌ बुरा उदाहरण:

int a = 5; स्ट्रिंग एस = "जॉन";

✅ अच्छा उदाहरण:

if (statusCode === 404) {  
    console.log("Not Found");  
}

int userage = 5; स्ट्रिंग उपयोगकर्ता नाम = "जॉन";

वही कार्यों पर लागू होता है। Dostuff () या प्रक्रिया () जैसे अस्पष्ट नामों से बचें। विशिष्ट रहो।

const NOT_FOUND = 404;

if (statusCode === NOT_FOUND) {  
    console.log("Not Found");  
}

४। सूखा (अपने आप को दोहराएं)

यदि आप कॉपी और पेस्टिंग कोड कर रहे हैं, तो आप इसे गलत कर रहे हैं। डुप्लिकेट कोड बग को एक बुरा सपना फिक्सिंग करता है। कार्यों या वर्गों में अमूर्त दोहरावदार तर्क। ❌ बुरा उदाहरण:

प्रिंट ("आपका स्वागत है, जॉन") प्रिंट ("वेलकम, मैरी")

✅ अच्छा उदाहरण:

if (statusCode === 404) {  
    console.log("Not Found");  
}

] प्रिंट (f "स्वागत है, {नाम}") ग्रीट_सर ("जॉन") ग्रीट_सर ("मैरी")

५। अपने कार्यों को छोटा रखें

int userAge = 5;  
String userName = "John";  

यदि आपका फ़ंक्शन 20-30 लाइनों से अधिक है, तो यह बहुत अधिक कर रहा है। इसे छोटे, पुन: प्रयोज्य कार्यों में तोड़ दें।

लंबे कार्यों से विशिष्ट व्यवहार को समझना और परीक्षण करना कठिन हो जाता है।

६। टिप्पणी का उपयोग करें
कोड लिखें जो स्वयं समझाता है। जटिल तर्क को स्पष्ट करने के लिए आवश्यक टिप्पणियों का उपयोग करें। उन टिप्पणियों से बचें जो स्पष्ट बताती हैं।

❌ बुरा उदाहरण:

print("Welcome, John")  
print("Welcome, Mary")  

✅ अच्छा उदाहरण:
यदि आपका कोड स्पष्ट है, तो किसी टिप्पणी की आवश्यकता नहीं है:

const NOT_FOUND = 404;

if (statusCode === NOT_FOUND) {  
    console.log("Not Found");  
}

काउंटर = 1;

] 7। अपने कोड को प्रारूपित करें और व्यवस्थित करें

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

डेवलपर की मानसिकता: मनुष्यों के लिए कोड लिखें कोड केवल मशीनों के लिए नहीं लिखा गया है; यह मनुष्यों के लिए भी लिखा गया है - आपके टीम के साथी, भविष्य के रखरखाव, या यहां तक ​​कि अपने आप को छह महीने नीचे लाइन से नीचे। जब आप स्वच्छ कोड लिखते हैं:

if (statusCode === 404) {  
    console.log("Not Found");  
}

आप दूसरों के लिए मानसिक भार को कम करते हैं।

आप डिबग करना, विस्तार करना और सुधार करना आसान बनाते हैं।
आप एक पेशेवर डेवलपर की तरह दिखते हैं जो गुणवत्ता को महत्व देता है।

const NOT_FOUND = 404;

if (statusCode === NOT_FOUND) {  
    console.log("Not Found");  
}

अंतिम विचार

गंदे कोड से बचना कठिन नहीं है - यह सिर्फ अनुशासन लेता है। इन सरल नियमों का पालन करें:

एकल जिम्मेदारी सिद्धांत से चिपके रहें।

• जादू की संख्या से बचें।
• स्पष्ट, वर्णनात्मक नामों का उपयोग करें।
• दोहरावदार कोड सूखा।

फ़ंक्शंस को कम रखें।

टिप्पणियों का उपयोग बुद्धिमानी से करें।
अपने कोड को लगातार प्रारूपित करें।

• क्लीन कोड पूर्णता के बारे में नहीं है; यह आपके काम को बनाए रखने योग्य और समझने योग्य बनाने के बारे में है। आपका भविष्य स्वयं और आपकी टीम - धन्यवाद होगा।
] ?