حافظ على نظافتها: كيفية كتابة رمز نظيف

اقرأ في الهندسة

الكود النظيف هو مفتاح البرنامج الذي يعمل بشكل جيد وسهل الصيانة. نلقي نظرة على كيفية كتابة رمز نظيف باستخدام هذا الدليل المفيد.

في حين أن غير المطلعين ينظرون إلى رمز الكمبيوتر ويرون خليطا طويلا من الحروف والأرقام ، إلا أنه منظم ومعقول للغاية. كل عبارة وحرف له غرض في الكود ويؤثر على المنتج النهائي.

ما لم تكن ، بالطبع ، تستخدم ممارسات ترميز سيئة.

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

كيفية كتابة كود نظيف

والخبر السار هو أن كتابة التعليمات البرمجية النظيفة ليست معقدة. الأمر كله يتعلق بممارسات الترميز المنطقية (والمجاملة الشائعة).

راجع منطقك قبل بدء البرمجة

تبدأ إحدى أفضل الطرق لبدء كتابة التعليمات البرمجية الجيدة قبل كتابة سطر واحد من التعليمات البرمجية.

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

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

اصطلاحات الاستخدام

هناك أيضا شيء يمكن قوله عن الاتساق في الكود ، والذي يقودنا إلى اصطلاحات التسمية.

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

اصطلاحات التسمية هي معيار يسمح للمبرمجين الآخرين بفهم التعليمات البرمجية الخاصة بك. كما يتيح لك معرفة ما تعمل به بالضبط.

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

اكتب ما تعنيه

هذا يبدو واضحا جدا ، أليس كذلك؟

ستندهش من عدد المبرمجين الذين يكافحون مع هذا المفهوم (ونتيجة لذلك ، كم من زملائهم يريدون الصراخ في كل مرة يتعين عليهم فيها فهم التعليمات البرمجية التي لا معنى لها).

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

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

المسافة البيضاء والمسافة البادئة هما أصدقاؤك

هناك سبب لتعليمنا كل مدرس لغة إنجليزية تقسيم فقراتنا - أعيننا لا تحب الجدران الصلبة للنص.

ينطبق نفس المبدأ الأساسي على رمز الكمبيوتر.

المسافة البيضاء قوية بشكل مدهش ، وربما لا تقل أهمية عن الكود مثل محتوى الكود نفسه. لماذا؟ لأنه بدون مسافة بيضاء ، يصعب قراءة الكود (ومحبط).

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

إذا تم لصق كل سطر من التعليمات البرمجية على الجانب الأيسر من الصفحة ، فمن الصعب معرفة أين ينتهي العنصر ، مما يجعل من الصعب تصميم بنية كاملة وفعالة.

لا توجد سلبيات ، ويستغرق القليل من الوقت. افعل لنفسك ولقرائك معروفا.

اكتب تعليقات توضيحية (لكن لا تسيء استخدامها!)

كما قلنا ، فإن الكثير من التعليمات البرمجية الجيدة تتضمن ممارسات مجاملة شائعة. هذا واضح في التعليقات.

التعليقات هي طريقة سهلة ومعالجة أي ارتباك أو شك قد يكون لدى الشخص أثناء قراءة التعليمات البرمجية الخاصة بك. لا تؤثر على المنتج النهائي ، لكنها تسهل كثيرا على شخص ما قراءة الكود.

ومع ذلك ، لا تبالغ في تعليقاتك.

تم تصميم التعليقات لتوضيح الوظائف ، وليس للعمل كملاحظات Post-It في الكود (على سبيل المثال ، / * ستنتهي من هذا لاحقا ... * / أو / * قامت Anna بترميز هذا ، اسألها * /).

تعليقات مثل هذه ليس لها غرض فعلي ولا تؤدي إلا إلى إرباك القراء لاحقا.

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

مسؤولية واحدة

بروح الحفاظ على البساطة ، يجب أن تبقي الوظائف مقتصرة على مسؤولية واحدة. إذا كانت لديك وظيفة تخدم غرضين أو ثلاثة أغراض ، ففكر في تقسيمها إلى وظائف متعددة.

إنه أسهل في الفهم وأسهل في القياس وأسهل في إعادة الاستخدام لاحقا.

تجنب الاختلاط العشوائي للغات الترميز

إذا كنت ترغب في إرباك وإحباط المبرمجين المستقبليين الذين يتعاملون مع التعليمات البرمجية الخاصة بك ، فهناك عدة طرق أسرع للقيام بذلك من الجمع بين أنماط CSS وعلامات JavaScript مع إجراءات قصيرة مضمنة فيها.

حتى التعليقات لا يمكن أن تنقذ هذه الفوضى المشوهة. حتى لو كانت التعليقات يمكن أن تحاول شرح ذلك ، فإن الكود لا يزال يبدو مثل كل شيء ، ولا شيء يتم تدويره في حساء الكود.

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

ابق أنيقا

أخيرا ، تأكد من أن تظل أنيقا.

كما هو الحال في ، إذا كنت تحاول احتواء الكثير من الوظائف في مكان واحد ، فمن الجيد إنشاء فصل منفصل للتعامل معها.

هذا كله يتعلق بإعادة الاستخدام والترتيب. على سبيل المثال ، إذا كان لديك عدة فصول تتعامل مع نفس الوظيفة ، ألن يكون من المنطقي جعلها جميعا تصل إلى نفس المكان لاستخدام هذه الوظيفة؟

بهذه الطريقة ، لا يشعر شخص ما بالارتباك عندما يحاول تذكر الفصول الثلاثة التي تفعل الشيء نفسه.

الاستفادة القصوى من الترميز النظيف

الآن بعد أن عرفت كيفية كتابة التعليمات البرمجية النظيفة ، انطلق واكتب برامج جميلة ومشفرة بشكل مرتب ستجعل المبرمجين في المستقبل يغنون بارتياح.

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

الائتمانات

فريق ديفوبس

الغرض من عملنا هو أتمتة ودمج أعمال تطوير البرمجيات من أجل تبسيط عملية التطوير وجعل النظام قابلا للتطوير.

جميع مشاركات المؤلف

طالع المزيد

كلما قرأت أكثر ، زادت الأشياء التي ستعرفها. كلما تعلمت أكثر ، زاد عدد الأماكن التي ستذهب إليها.