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

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

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

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

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

راجع منطقك قبل أن تبدأ في الترميز

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

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

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

استخدم الاتفاقيات

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

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

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

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

اكتب ما تعنيه

يبدو أن هذا بسيط جداً، أليس كذلك؟

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

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

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

المسافات والتراجع أصدقاؤك

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

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

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

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

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

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

اكتب تعليقات تفسيرية (لكن لا تفرط فيها!)

كما قلنا، الكثير من الكود الجيد يتضمن ممارسات الأدب المشترك. يتجلى ذلك في التعليقات.

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

ومع ذلك، لا تفرط في استخدام تعليقاتك.

التعليقات مصممة لتوضيح الوظيفة، وليست لتكون ملاحظات لاصقة داخل الكود (مثل /*سأنتهي من هذا لاحقاً...*/ أو /*أنتا كتبت هذا، اسألها*/).

التعليقات مثل هذه ليس لها غرض فعلي وتعمل فقط على إرباك القُرّاء لاحقاً.

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

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

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

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

تجنب الخلط غير المنظم بين لغات البرمجة

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

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

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

ابق أنيقاً

أخيراً، تأكد من البقاء أنيقاً.

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

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

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

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

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

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