كتابة كلين كود اهم 4 قواعد عملية

Nice Topic 24 يوليو، 2022

نتكلم هنا عن كتابة كلين كود و  اهم أساسياته

كتابة كلين كود

كلين كود

عمرك سألت نفسك هل أنا بكتب Clean Code؟
كلنا بنكتب أكواد بتفهمها أجهزتها بس المبرمج الشاطر هو يلي قادر يكتب برنامج يفهمها البشر.
والطريق يبدأ بكتابة”clean code”

  • طيب أيش هو الClean Code؟
  • هل لازم أكون مبرمج محترف عشان أقدر أكتب هذه الاكواد؟
  • وهل محتاج أتعلم لغة
  •  كيف ابدأ

رفاهية كتابة كود برمجي بدون اضافة تعديلات بين الوقت والآخر قد تكون موجودة بس في كوكب غير الأرض

  • وعشان مهمة التعديل بتكون أصعب المهام يلي بتطلب من المبرمج لأنها بتأخذ وقت وجهد في تتبع مكان التعديل وال errors يلي بتظهر ظهر مفهوم ال “clean code”
  • الذي هو ببساطة إنك تتبع قواعد معينة عندما تكتب أكواد برامجك بطريقة تخليك
    1- تقدر تقرأه انت او اي شخص آخر
    2- تقدر تعدل عليه بسرعة وبسهولة
  • مش لازم تكون مبرمج محترف عشان تبدأ تكتب أكوادك بطريقة Clean ولا هي طريقة مستخدمة بس مع بعض اللغات البرمجية والباقي لا.
  • سواء ستبدأ بكتابة كود برمجي من سطرين أو من مليون
  • فاتباعك لقواعد ال clean code هتخليك تريح رأسك من صداع تعديلات البرنامج بعد جملة العميل المشهورة “بس فيه تعديل بسيط!” ويلي قد تأخذ وقت أكثر من الوقت يلي انكتب فيه الكود كامل.

 قواعد ال Clean Code

1- التسميات
الأسماء في كل مكان داخل البرنامج.
بنسمي المتغيرات بنسمي الfunction, arguments, classes والملفات نسمي ونسمي ونسمي

وعشان أكثر شي بنفعله لازم يكون أكثر شي نأخذ بالنا منه طيب كيف؟

  1.  إختار أسماء معبرة عن محتوى المتغير int t;
  2.  إختار أسماء نقدر ننطقها ونفهمها يعني لاتستخدم كلمات واختصارات ما لها أي معنى
  3. إبعد ألف متر من إستخدام التشفير والتعقيد يعني أسماء ما يفهما إلا أنت
  4. (الأسماء) للمتغيرات/للكلاسات و (الأفعال) للmetods

2- ال Function

  1. أول شي نأخذه بعين الاعتبار لما نكتب functions برنامجنا هو أنه تكون صغيرة وثاني شي انها تكون أصغر من الصغيرة دام السطور يلي داخل ما لها لازمة احذفها
  2. لما نكتب جمل التحكم والتكرار (if&for) نرتب الblock بشكل صحيح لانترك مسافات كبيرة ولو الجمل يلي تأتي بعد ال if أكثر من سطر يفضل نحطهم داخل function وبعدين نستدعيها
  3. ما نزيد عدد ال arguments كلما كان عددها أقل كلما زادت فعالية الكود
  4. خلي الfunction تنفذ وظيفة واحدة مثلاً تريد منها تحسب مرتب الموظف بس stop لاتزيد لها وظيفة أخرى وهكذا
  5. DRY(Don’t Repeat Yourself) ومعناه أن لو فيه سطور برمجية بتتكر دورياً وسط الكود حطها داخل function وكلما أحتاجها يتم الاستدعاء

3- إستخدم try – catch

من أجل تعرف مكان الغلط أسرع وانتبه تستبدلها ب if-else لتتجنب الاخطاء
كمثال

If ماحصل كذا
else طلع رسالة خطاء

4- التعليقات Comments

كتابة الcomments في برنامجك مش بيعوض عن كتابة الكود السئ bad code is bad cod
ومابيعوض عن القواعد السابقة كلها

متى نقدر نستخدم التعليقات؟

  1.  لما تحب تضع معلومات عن ملكية الكود أو مواقع أخذ المعلومات
  2.  لما تكون خايف إن فكرة السطر البرمجي لن تصل بالشكل المطلوب
  3.  لما تحب تشرح عمل المتغير أو الكلاس
  4.  لما تحب تضع إشارة في مكان في الكود لترجع تعدل أو تضيف عليه في وقت لاحق. TODO comment
  •  وفي الأخير لا تكتب شعر في الكومنت ‘ما قل ودل’.
  •  ولو حسيت إنك كتبت اسطر برمجية غلط احذفها بدل ما تحطها كتعليق لوقت الحاجة أو خوفاً إنك ترجع تحتاجها لأن هذه عادة سيئه بيقوم فيها المبرمج.

وكانت هذه أهم القواعد يلي تكلم عنها uncle Bob صاحب الكتاب الشهير يلي تقدروا تطلعوا عليه وتقرأوا عن الموضوع بتفصيل أكثر
وكمان فيه عدة كورسات في اليوتيوب بتشرح هذا الكتاب باللغة العربية والإنجليزية

ولأن Time is Money  وخاصة للمبرمج