الأسماء الواضحة توثيق يعيش مع الكود

اسم المتغير أو الدالة الجيد يكشف الغرض مباشرة، ويقلل الوقت الذي يقضيه الفريق في تفسير الكود أو مطاردة التعليقات القديمة.

عُمَر العلوي مقال

الكود وسيلة تواصل بين المطورين قبل أن يكون أوامر للحاسوب. التعبير totalAmount = price × quantity يكشف القصد، بينما تجبر أسماء مثل x وa وb القارئ على البحث في السياق لمعرفة الشيء نفسه.

سمِّ الدالة بحسب النتيجة التي تحققها، مثل generateInvoicePdf بدل generateFile، وsendOrderConfirmationEmail بدل processOrderEmail. استخدم الجمع للمجموعات والمفرد للعنصر، واجعل أسماء القيم المنطقية أسئلة طبيعية تبدأ مثلًا بـ is أو has أو can أو should.

تجنب الاختصارات غير المتفق عليها والأسماء العامة مثل data وinfo وprocess. التعليقات تشرح السبب أو القيد الذي لا يظهر من الكود، لا تعيد وصف ما تقوله الأسماء. اختيار الاسم يحتاج وقتًا قصيرًا، لكنه يتكرر نفعه في كل قراءة ومراجعة وتعديل لاحق.

شاركني رأيك

يسعدني مشاركة وجهة نظرك من خلال ترك تعليق في المقالة الأصلية في مواقع التواصل

مقالات مرتبطة

خطورة تراكم الديون التقنية

جودة الكود والممارسات ·

خطورة تراكم الديون التقنية

الحلول السريعة غير المدروسة تتحول إلى تراكمات، والتراكمات تتحول إلى ديون تقنية، والديون تصبح كابوس يهدد البزنس.

قراءة المقال

جودة الكود والممارسات ·

علامات مبكرة على تراجع جودة الكود

الكلاسات الضخمة والتكرار والأسماء الغامضة ليست مشكلات شكلية؛ إنها إشارات إلى ارتفاع كلفة التغيير وزيادة احتمال الخطأ.

قراءة المقال