شعار ConstructiCat
CodeBust.
تصفح القسم ▾

التعليقات.

أسلوب مليء بتعليقات توضيحية.

##العلامات والأعراض

أسلوب مليء بتعليقات توضيحية.

// السماح بالوصول للمسؤولين والمالك
if (user.role == Role.ADMIN || order.ownerId == user.id) {
  show(order);
}

##أسباب المشكلة

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

أفضل تعليق هو اسم جيد لأسلوب أو كلاس.

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

##المعالجة

##الفوائد

  • يصبح الكود أكثر بداهةً ووضوحاً.