استعمال التعليقات و تسمية الكلاسات

أقدم لك بعض النصائح حتى يكون كودك نظيفاً ومرتباً:

1- اجعل الكود قابلاً للقراءة للأشخاص

ضعّ في مخيلتكَ أن هناك احتمال أن يتمكن شخص آخر من الوصول إلى الكود البرمجي الخاص بنا ، أو أن يتعامل معها.

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

// Bad

class CarouselLeftArrow extends Component{render(){return ( );}};

// Better

class CarouselLeftArrow extends Component { render() { return ( ); } };

2- استخدام تسميات واضحة ل variables, functions ,methods

// Bad

const fnm = ‘Tom’; const lnm = ‘Hanks’ const x = 31; const l = lstnm.length; const boo = false; const curr = true; const sfn = ‘Remember the name’;

});

// Better

const firstName = ‘Tom’; const lastName = ‘Hanks’ const age = 31; const lastNameLength = lastName.length; const isComplete = false; const isCurrentlyActive = true; const songFileName = ‘Remember the name’;

});

3-دع ال functions و methods تؤدي مهمة واحدة فقط

// Example no.1: Simple subtraction

function subtract(x, y) { return x - y;

}

// Example no.2: Simple multiplication

function multiply(x, y) { return x * y;

}

// Example no.3: Double numbers in an array

function doubleArray(array) {

return array.map(number => number * 2)

}

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

5- قم بمراجعة كودك بإستمرار

اتبع هذه النصائح وإن شاء الله ستجد تحسناً في كتابة كود نظيف .

** يوجد كتاب مميز عن كتابة كود نظيف إسمه (A Handbook of Agile Software Craftsmanship) يمكن كتابة اسمه على محرك البحث وهو أيضا مضاف على متجر أمازون