واجهها كل مطور: الكود القذر - نوع الكود الذي يبدو أنه تم كتابته بعجلة ، ورشت بالأرقام السحرية ، وكتل مكررة ، وأسماء متغيرة خفية. إنه يعمل ... بالكاد. لكن الحفاظ عليه؟ هذا كابوس.

إذا كنت قد تمتمت تحت أنفاسك أثناء إعادة تمثيل رمز شخص آخر (أو حتى الخاص بك) ، فإن هذه المقالة هي لك. فيما يلي بعض القواعد البسيطة للحفاظ على الكود نظيفًا وقابل للقراءة ومقاومة للمستقبل.

ما هو الكود القذر؟
الرمز القذر هو رمز ما:

• يصعب قراءة أو فهم.
• يفتقر إلى الهيكل والاتساق.
• من الصعب تعديل أو تصحيح دون كسر شيء آخر.

يحدث هذا غالبًا عندما يكون المطورين:

1. العمل تحت المواعيد النهائية الضيقة.
2. تخطي مراجعات التعليمات البرمجية.
3. لا تتبع أفضل الممارسات أو المعايير.

لماذا الكود القذر مشكلة؟

• من الصعب تصحيح: إصلاح خطأ واحد يمكن أن يقدم خمسة آخرين.
• باهظ الثمن للحفاظ على: يستغرق الرمز المكتوب بشكل سيئ وقتًا أطول لتحسين.
• ارتباك الفريق: يقضي مطورون جدد ساعات إضافية في محاولة لفهم ما يحدث. قد تنجز رمز القذرة المهمة اليوم ، لكنها قنبلة موقوتة لفريقك ونفسك في المستقبل.

قواعد بسيطة لتجنب الكود القذر

1. اتبع مبدأ المسؤولية الفردية (SRP)
يجب أن تفعل كل وظيفة أو طريقة أو فئة شيئًا واحدًا فقط. إذا وجدت نفسك تكتب أساليب مع الكثير من المسؤوليات ، فقم بتقسيمها إلى وحدات أصغر.

❌ مثال سيء:

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

✅ مثال جيد:

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")  

كل وظيفة لديها الآن وظيفة واضحة واحدة ، مما يجعل الكود أسهل في الاختبار والتعديل.

2. تجنب الأرقام والسلاسل السحرية
تجعل القيم المرمزة ("الأرقام السحرية") رمزًا غير قابل للقراءة ويصعب الحفاظ عليه. استخدم الثوابت بدلاً من ذلك.

❌ مثال سيء:

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

✅ مثال جيد:

const NOT_FOUND = 404;

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

الثابت not_found هو توضيح ذاتي ، مما يجعل القراءة من الكود الخاص بك أسهل.

3. اكتب متغيرًا وصفيًا وأسماء الوظائف
يجب أن تعكس أسماء المتغيرات الخاصة بك ما تمثله. تجنب الاختصارات والأسماء الخفية.

❌ مثال سيء:

int a = 5;  
String s = "John";  

✅ مثال جيد:

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

ينطبق الشيء نفسه على الوظائف. تجنب أسماء غامضة مثل dostuff () أو Process (). كن محددًا.

4. جاف (لا تكرر نفسك)
إذا كنت تقوم بنسخ التعليمات البرمجية ولصقها ، فأنت تفعل ذلك بشكل خاطئ. رمز مكرر يجعل الأخطاء إصلاح كابوس. مجردة المنطق المتكرر في وظائف أو فئات.

❌ مثال سيء:

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

✅ مثال جيد:

def greet_user(name):
    print(f"Welcome, {name}")  

greet_user("John")  
greet_user("Mary")  

5. حافظ على وظائفك قصيرة
إذا كانت وظيفتك أطول من 20-30 سطرًا ، فإنها تفعل الكثير. قم بتقسيمها إلى وظائف أصغر قابلة لإعادة الاستخدام.

وظائف طويلة تجعل من الصعب فهم واختبار سلوك معين.

6. استخدم التعليقات بشكل ضئيل
اكتب الكود الذي يفسر نفسه. استخدم التعليقات فقط عند الضرورة لتوضيح المنطق المعقد. تجنب التعليقات التي تنص على ما هو واضح.

❌ مثال سيء:

// Increment the counter by 1  
counter = counter   1;  

✅ مثال جيد:
إذا كان الكود الخاص بك واضحًا ، فلن يكون هناك حاجة إلى تعليق:

counter  = 1;  

استخدم تعليقات لأشياء مثل توضيح سبب اتخاذ قرار معين ، وليس ما يفعله الرمز.

7. تنسيق وتنظيم الكود الخاص بك

• اتبع دليل نمط الترميز المتسق (على سبيل المثال ، Pep8 لـ Python ، Eslint for JavaScript).
• استخدم المسافة البادئة المناسبة.
• الكود المتعلق بالمجموعة معًا. التنسيق الجيد يجعل التعليمات البرمجية نظيفة وقابلة للقراءة دون أي جهد إضافي.

عقلية المطور: اكتب رمزًا للبشر
الكود ليس مكتوبة فقط للآلات ؛ إنه مكتوب للبشر أيضًا - زملائك في الفريق ، أو المشرفون في المستقبل ، أو حتى نفسك على بعد ستة أشهر من الخط. عندما تكتب رمزًا نظيفًا:

• يمكنك تقليل الحمل العقلي للآخرين.
• يمكنك تسهيل تصحيح الأخطاء وتمديدها وتحسينها.
• تبدو وكأنه مطور محترف يقدر الجودة.

الأفكار النهائية
تجنب الكود القذر ليس صعبًا - إنه يتطلب الانضباط. اتبع هذه القواعد البسيطة:

1. التمسك بمبدأ المسؤولية الفردية.
2. تجنب الأرقام السحرية.
3. استخدم أسماء وصفية واضحة.
4. جفاف الكود المتكرر.
5. الحفاظ على وظائف قصيرة.
6. استخدم التعليقات بحكمة.
7. تنسيق الكود الخاص بك باستمرار.

الكود النظيفة لا يتعلق بالكمال ؛ يتعلق الأمر بجعل عملك قابلاً للصيانة ومفهومة. ستشكر نفسك في المستقبل - وفريقك - شكرًا لك.

الآن اذهب و refactor هذا الرمز الفوضوي الذي كنت تتجاهله! ؟