الكود النظيف (Clean Code) هو الكود الذي يقرأه الإنسان بسلاسة قبل أن ينفذه الحاسوب، ويتميز بوضوح التسميات، وصغر حجم الدوال، وتقليل التداخل الشرطي، مما يخفض تكلفة الصيانة والأخطاء البرمجية بشكل جذري.
القواعد العشر لرفع جودة شيفرتك البرمجية
نقضي في قراءة الكود وصيانته وقتاً أطول بعشر مرات من الوقت الذي نقضيه في كتابته لأول مرة؛ لذا التزم بهذه القواعد اليومية:
قد يعجبك ايضا
- أسماء معبّرة: استبدل
dوtempبأسماء واضحة مثلdays_since_login. - العودة المبكرة (Early Return): اعكس شروط الفشل وأنهِ الدالة مبكراً لتتخلص من هرم الـ
ifالمتداخل. - دالة واحدة لمهمة واحدة: إذا احتوت الدالة على كلمة «و» في وصفها، فغالباً يجب تقسيمها.
- تجنب الأرقام السحرية (Magic Numbers): ضع القيم الثابتة مثل
86400في ثابت مسمىSECONDS_PER_DAY. - لا تكرر نفسك (DRY): استخرج المنطق المتكرر في دالة مشتركة، دون المبالغة في التجريد المبكر.
- التعليقات تشرح «لماذا» لا «ماذا»: الكود الواضح يشرح نفسه؛ اكتب التعليق لتوضيح سبب قرار هندسي غير بديهي.
- معالجة الأخطاء بوضوح: لا تبتلع الاستثناءات بصمت داخل
except: pass. - حذف الكود الميت: لا تترك دوال معلقة بالتعليقات، فنظام Git يحفظ التاريخ كاملاً.
- تقليل المعاملات: اجعل معاملات الدالة 3 أو أقل، أو اجمعها في كائن إعدادات.
- تنسيق موحد: استخدم أدوات التنسيق التلقائي مثل Ruff أو Black أو Prettier.
مقارنة سريعة: الكود الفوضوي مقابل الكود النظيف
المظهركود يحتاج إعادة هيكلةكود نظيف (Clean Code)التحقق من الشروطتداخل 4 مستويات من if/elseحراس تحقق مبكرة (Guard Clauses)المتغيراتاختصارات غامضة (x1, res, flg)أسماء تصف النية ونوع القيمةالتعامل مع الأخطاءإرجاع None صامت يخفي السببرفع استثناءات محددة واضحة
تطبيق قاعدة العودة المبكرة
# كود نظيف باستخدام Guard Clauses
def process_withdrawal(account, amount: float) -> str:
if not account.is_active:
return "الحساب غير نشط"
if amount <= 0:
return "المبلغ غير صالح"
if account.balance < amount:
return "رصيد غير كافٍ"
account.balance -= amount
return "تم السحب بنجاح"
أي مبرمج يستطيع كتابة كود يفهمه الحاسوب؛ المبرمج المحترف هو من يكتب كوداً يفهمه زملاؤه دون الحاجة لشرحه شفهياً.
أسئلة شائعة
- السؤال: هل كتابة الكود النظيف تبطئ سرعة إنجاز المهام؟ الإجابة: قد تأخذ دقائق إضافية في البداية، لكنها توفر أسابيع من تصحيح الأخطاء لاحقاً.
- السؤال: هل التعليقات الكثيرة علامة على كود جيد؟ الإجابة: غالباً العكس؛ كثرة التعليقات قد تعني أن الكود معقد وبحاجة إلى إعادة تسمية وتبسيط.
- السؤال: ما أفضل أداة أوتوماتيكية للحفاظ على نظافة كود بايثون؟ الإجابة: أداة Ruff التي تجمع بين الفحص السريع والتنسيق التلقائي في جزء من الثانية.
التعليقات (0)
أضف تعليقك