نصائح لكتابة كود أفضل

نصائح لكتابة كود أفضل! اكيد سألت نفسك فى يوم من الأيام كيفية جعل كودى أنظف واحسن وقابل للفهم والقراءة؟ للإجابة على السؤال السابق إتبع هذه النصائح.👇

7 نصائح لكتابة كود أفضل

1. استخدام أسماء وصفية ذات معنى مٌعبر

يجب ان تكون قواعد استخدامك لأسماء المتغيرات Variable والدوال Function جيده وذات معنى.

من حيث:

• أسماء المتغيرات: يجب أن يكون اسم المتغير معبر على الشئ الذى سيقوم به.
• أسماء الدوال: يجب أن يكون اسم الدالة معبر على الشئ الذى سيقوم به أو الأكشن اللى هينفذه.

لاحظ الفرق بين المثالين لزيادة الفهم:

المثال الأول (بدون إستخدام أسماء وصفية ذات معنى معبر):

// Declare a variable
var text = "You are Login successfully!";

// Declare a function
function text() {
    alert("You are Login successfully!");
}

المثال الثانى (بإستخدام أسماء وصفية ذات معنى معبر):

// Declare a variable
var successLoginMsg = "You are Login successfully!";

// Declare a function
function successLoginMsg() {
    alert("You are Login successfully!");
}

2. كتابة التعليقات الجيدة

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

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

المبرمج المحترف يهتم دائمًا بكتابة التعليقات التوضيحية على كل كود لتوضيح الكود الخاص به وجعله أفضل دائمًا!

لاحظ الفرق بين المثالين لزيادة الفهم:

المثال الأول (بدون إستخدام التعليقات):

function validate_phone_number($phone){
    $filtered_phone_number = filter_var($phone, FILTER_SANITIZE_NUMBER_INT);
    $phone_to_check = str_replace("-", "", $filtered_phone_number);
    if (strlen($phone_to_check) < 10 || strlen($phone_to_check) > 14) {
    return false;
    } else {
    return true;
    }
}

المثال الثانى (بإستخدام التعليقات):

// Function for "validate phone number"
function validate_phone_number($phone){
    // Allow +, - and . in phone number
    $filtered_phone_number = filter_var($phone, FILTER_SANITIZE_NUMBER_INT);
    // Remove "-" from number
    $phone_to_check = str_replace("-", "", $filtered_phone_number);
    // Check the length of number
    // This can be customized if you want phone number from a specific country
    if (strlen($phone_to_check) < 10 || strlen($phone_to_check) > 14) {
    return false;
    } else {
    return true;
    }
}

3. استخدام معايير كتابة الكود

كود جيد عادًه ما يتبع بعض المعايير لجعله مناسب لمعايير كتابة الكود البرمجى بنسبة 100%. وكتابتك لكود متابع لمعايير برمجية يسهل على الأشخاص الذين يقرؤن أو يعدلون على الكود بعد ذلك!

4. تجنب المتغيرات العامة – Global Variables

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

5. إعادة تشكيل كودك

أقصد بإعادة تشكيل كودك أن تقوم بإعادة النظر على كل سطر برمجى قمت بكتابتة. لتتأكد بأنه سليم 100% وخالى من الأخطاء تمامًا، لأنك ربما تكون إتسرعت فى الكتابة فنسيت تكتب حرف أو علامة ترقيم أو أى شىء أخر! فالبتالى هيسبب مشاكل توقف عمل مشروعك أو تطبيقك.

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

6. حذف الكود الغير ضرورى

هذه العادة السيئة هي التي كنت أواجهها من قبل! عادة ما يحدث مثل هذه الحالة: أريد إصلاح أو تحسين جزء من التعليمات البرمجية لذلك أعلق عليه (أهمشة بالكامل) وأعد كتابة أسفله مباشرة التعليمات الجديدة – وعلى الرغم من أن التعليمات الجديدة تعمل ، إلا أنني أحتفظ بالكود القديم!

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

7. الذكاء وسهولة قراءة الكود

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

لذلك قُم بكتابة كود نظيف دائمًا وقُم بتحسين هذا الكود للشخص الذي سيعدل عليه من بعدك!