الكتابة النظيفة: 7 نصائح لتحويل الكود الفوضوي إلى تحفة فنية

مقدمة: عندما يصبح الكود كابوسًا

بتذكر أول مشروع كبير اشتغلت عليه، كان عبارة عن فوضى عارمة! 😅 أكواد مكررة، أسماء متغيرات غير مفهومة، وتعليقات قليلة جدًا. كل ما أذكر أني كنت أعد الأيام لحتى أخلّص هالمشروع وأفتك منه. بعد فترة، اضطريت أرجعله عشان أعدل عليه، وهون كانت الصدمة! ما عرفت شو كنت كاتب ولا ليش! تعلمت وقتها درس مهم: الكود النظيف مش رفاهية، هو ضرورة.

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

1. أسماء معبرة وواضحة: أساس الكود النظيف

تخيل لو كل المتغيرات والوظائف ببرنامجك مسمية بأسماء زي x، y، function1، function2. كارثة، صح؟ اختيار أسماء معبرة وواضحة هو الخطوة الأولى نحو الكود النظيف.

نصيحة عملية:

• استخدم أسماء طويلة بما يكفي لتوضيح الغرض: avoid `i`, use `index`.
• اتبع اصطلاحات التسمية (naming conventions) الخاصة باللغة اللي بتستخدمها: CamelCase for classes, snake_case for functions in Python.
• كن متناسقًا في تسمية المتغيرات والوظائف: استخدم نفس النمط في كل البرنامج.

# سيء
def calc(x, y):
    return x * y

# جيد
def calculate_area(length, width):
    return length * width

2. وظائف قصيرة ومحددة الهدف: وحدة البناء الأساسية

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

نصيحة عملية:

• الوظيفة لازم ما تتعدى 20-30 سطر: إذا تعدت، فكر بتقسيمها.
• كل وظيفة لازم تعمل شغلة وحدة وبس: إذا بتعمل أكتر من شغلة، قسمها لوظائف أصغر.
• استخدم الأفعال في أسماء الوظائف: `calculate_area`, `validate_input`, `send_email`.

# سيء
def process_order(order):
    # التحقق من صحة الطلب
    # حساب المبلغ الإجمالي
    # إرسال بريد إلكتروني للتأكيد
    # تحديث حالة الطلب في قاعدة البيانات
    pass

# جيد
def validate_order(order):
    pass

def calculate_total(order):
    pass

def send_confirmation_email(order):
    pass

def update_order_status(order):
    pass

def process_order(order):
    if validate_order(order):
        total = calculate_total(order)
        send_confirmation_email(order, total)
        update_order_status(order, "تم التأكيد")

3. التعليقات: دليل المستخدم للكود

التعليقات مهمة جدًا، بس مش لازم تكون كتير لدرجة إنها تخفي الكود. التعليق لازم يشرح ليش الكود بيعمل هيك، مش شو بيعمل. الكود الواضح بغني عن أغلب التعليقات.

نصيحة عملية:

• علّق على الأجزاء المعقدة أو الغير واضحة من الكود: اشرح المنطق وراء القرار.
• حدث التعليقات لما تغير الكود: التعليقات القديمة أسوأ من عدم وجود تعليقات أصلًا.
• تجنب التعليقات اللي بتشرح شو بيعمل الكود: الكود لازم يكون واضح كفاية لحتى يفهم لحاله.

# سيء
# زيادة العداد بمقدار 1
i = i + 1

# جيد
def calculate_discount(price, discount_percentage):
    """
    حساب قيمة الخصم على المنتج.

    يتم استخدام هذه الوظيفة لحساب قيمة الخصم بناءً على سعر المنتج ونسبة الخصم.
    """
    discount = price * (discount_percentage / 100)
    return discount

4. التنسيق والمسافات: جمالية الكود

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

نصيحة عملية:

• استخدم أداة تنسيق الكود (code formatter): زي `Black` في Python أو `Prettier` في JavaScript.
• اتبع اصطلاحات التنسيق الخاصة باللغة اللي بتستخدمها: زي PEP 8 في Python.
• كن متناسقًا في التنسيق: استخدم نفس النمط في كل البرنامج.

5. تجنب التكرار: DRY (Don’t Repeat Yourself)

التكرار هو عدو الكود النظيف. إذا بتلاقي حالك بتكرر نفس الكود، حوله لوظيفة أو كلاس.

نصيحة عملية:

• استخرج الكود المتكرر لوظيفة أو كلاس: قلل التكرار قدر الإمكان.
• استخدم المكتبات والإطارات الجاهزة: لا تعيد اختراع العجلة.

# سيء
def calculate_rectangle_area(length, width):
    return length * width

def calculate_square_area(side):
    return side * side

# جيد
def calculate_area(length, width=None):
    if width is None:
        width = length
    return length * width

6. التعامل مع الأخطاء: كن مستعدًا لكل شيء

الكود النظيف لازم يتعامل مع الأخطاء بشكل صحيح. استخدم `try-except` أو ما يعادله في لغتك للتعامل مع الأخطاء المحتملة.

نصيحة عملية:

• استخدم `try-except` للتعامل مع الأخطاء المحتملة: لا تدع البرنامج ينهار بسبب خطأ بسيط.
• سجل الأخطاء (log errors): عشان تقدر تحل المشاكل بعدين.
• أظهر رسائل خطأ واضحة للمستخدم: عشان يعرف شو المشكلة وكيف يحلها.

7. الاختبارات: ضمان الجودة

الاختبارات هي جزء أساسي من الكود النظيف. اكتب اختبارات لكل جزء من الكود عشان تتأكد إنه بيشتغل صح.

نصيحة عملية:

• اكتب اختبارات للوظائف والكلاسات: تأكد من إنها بتشتغل صح في كل الحالات.
• استخدم أطر عمل الاختبار (testing frameworks): زي `pytest` في Python أو `Jest` في JavaScript.
• شغل الاختبارات بشكل دوري: تأكد إن الكود لسه بيشتغل صح بعد كل تعديل.

الخلاصة: الكود النظيف رحلة مستمرة 🚀

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

نصيحة مني: خصص وقت كل أسبوع لمراجعة الكود تبعك وتنظيفه. رح تتفاجأ من كمية التحسينات اللي بتقدر تعملها. 😉