تريند 🔥

🌙 رمضان 2024

اتيكيت كتابة الأكواد – نصائحٌ للمبرمجين الجدد لتعلُّم كتابة أكواد أنيقة وفعّالة

نصائح لكتابة الاكواد
ريم أبو عجيب
ريم أبو عجيب

5 د

عند البدء بتعلُّم البرمجة تكون النصيحةُ الأولى من معلميك أن تكتب وتتعلّم بحذر! لكن شيئًا فشيئًا الكثير منا يضيعون في بحر وضغط التكويد، وخاصةً في أوقات إنجاز وتسليم المشاريع… تشرع في الكتابة وتنسى نفسك لتجد في النهاية عددًا لا نهائيًا من التعليقات والتعليمات التي لا تعرف لماذا كتبتها في الأصل!

متغيرات هنا وهنالك… وقيم ابتدائية عشوائية وتوابع قد تمَّ تعليقها لسبب ما قد ضاع في زحمة العمل؛ يحصل هذا كثيرًا وخصوصًا إن كنتَ تعمل على فكرة قد لمعت فجأةً في دماغك دون أي تخطيط مسبق.

ولتتبلور فكرتك على شكل مشروع ناجح لا بدَّ لك من أخذ دروس في “الاتيكيت” إن صح القول … فكيف تكتب أكوادًا أنيقةً وفعّالةً بنفس الوقت؟


احرص على أن تكون الأكوادُ مقروءةً بالنسبة للآخرين

ولماذا قد أرغب في أن أجعل الأكواد مقروءة… أليس المهم أن يعمل، الآلة ستقرأ وتفهم وتنفذ!! لكن ماذا لو أردت أن تعدل أمرًا ما بعد مدة زمنية؟ أو كان لديك شريكٌ في العمل على سبيل المثال.


استخدم أسماء ذات معنى للتوابع والمتغيرات…

جعل الأكواد مقروءة بالنسبة للآخرين أمر بالغ الأهمية، ولا بدَّ لكلّ مبرمج أن يمرن نفسه على الكتابة بتروي، ومن الأمور الهامة والبسيطة التي ستسهل عليك هذه العملية هي الأسماء التي تعبر عن وظيفة كل جزء من البرنامج.

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

نص برمجي 1

الرجل المناسب في المكان المناسب!

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

ما المشكلة؟

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

هذه النصيحة قادمة من “مبدأ المهمة الواحدة Single responsibility principle“، الذي ينص على أنّه يجب على كلّ تابع أن يؤدي مهمة واحدة فقط كما يتضح من اسم المبدأ ليكون هنالك سبب واحد للتعديل! وهو أول قانون من أساسيات تصميم البرمجيات الخمسة S.O.L.I.D

اتباع هذه النصيحة سيسهل عليك عمليات التعديل، وإيجاد الأسماء المناسبة كذلك الأمر… مهمة واحدة تعني سبب واحد للتعديل، ولا مزيد للبحث عن مصدر الخطأ الذي يمكن أن يصل في بعض الأحيان لتعقيد يشبه البحث عن إبرة في كومة قش!

نص برمجي 2

استخدم التعليقات للتوضيح

التعليقات جزء هام جدًا من البرنامج، والسبب بسيط! قد لا تبدو الأمور دومًا بنفس المنطقية بعد فترة من كتابتها ليست لأنّها صعبة، الأمر فقط أنّه يمكن أن تنسى!!

قد تعود للكود بعد أسابيع من كتابته ولا تدري لماذا وضعت هذه التعليمة أو المتغير أو التابع هنا وليس بعد سطرين مثلًا. إضافة التعليقات ستساعدك أنت ومن قد يعمل على نفس الكود في البقاء على اطّلاع على كلّ تفصيل.

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


اثبت على رأيك، واجعل من طريقة كتابة الكود نمط حياة!

من غير المفيد على الإطلاق اتباع أساليب متنوعة في كتابة الأكواد، يمكنك خوض غمارها كلها لكن في النهاية من الأفضل أن تأخذ أُسلوبًا واحدًا لتتقنه، وتعتمد عليه في كتابة برامجك!

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


احرص على مراجعة الكود بشكلٍ كامل حتى بعد حين

عملك كمبرمج لا ينتهي مع الفاصلة المنقوطة الأخيرة والقوس الأخير، فالأكواد تتطلب العناية مثل سيارتك أو هاتفك المحمول تمامًا، كلما كتبت برنامجًا توجب عليك الرجوع إليه كلّ فترة، والعمل على تحسينه وإصلاح ما قد ينتج من أخطاء، أو تعديل خوارزمياتك لتكون فعّالة أكثر.

الأكواد تصبح أكثر تعقيدًا مع مرور الزمن، ومع كلّ إضافة تقوم بها، فلا تنسَ أن تعود لتنظيف النص البرمجي ككلّ، وإلّا ستكون هذه الأكواد منتهيةَ الصلاحية خلال فترة وجيزة!


إن كان الكود يعمل فلِمَ كل هذه التفاصيل؟

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

ذو صلة

هذه النصائح بسيطة بالشكل لكن قيمة في الجوهر، ولا بدَّ لكلّ مبرمج أن يجعل منها عادةً ليكون عمله أنيقًا وفعّالًا في نفس الوقت!

أحلى ماعندنا ، واصل لعندك! سجل بنشرة أراجيك البريدية

بالنقر على زر “التسجيل”، فإنك توافق شروط الخدمة وسياسية الخصوصية وتلقي رسائل بريدية من أراجيك

عبَّر عن رأيك

إحرص أن يكون تعليقك موضوعيّاً ومفيداً، حافظ على سُمعتكَ الرقميَّةواحترم الكاتب والأعضاء والقُرّاء.

ذو صلة