كتابة كود واضح وسهل القراءة

اتبع دليل نمط PEP 8

• استخدم مسافتين للتباعد بدلاً من علامات التبويب.
• اكتب أسماء الوظائف بحرف صغير واستخدم الشرطة السفلية لفصل الكلمات (e.g. my_function).
• ابدأ أسماء المتغيرات بحرف صغير (e.g. my_variable).

استخدم أسماء متغيرات وصفية

• لا تستخدم أسماء غامضة مثل x و y.
• حدد المتغيرات بأسماء تصف محتوياتها (e.g. customer_name بدلاً من name).

اتبع التباعد الثابت

• استخدم مسافتين للتباعد بين العناصر في القوائم والقواميس.
• قم بمحاذاة العناصر ذات الصلة رأسياً لسهولة القراءة.

علق الكود الخاص بك

• اشرح الكتل المعقدة من الكود باستخدام التعليقات (e.g. """ """)
• اكتب تعليقات موجزة وواضحة يمكن فهمها بسهولة.

قسم الكود إلى وحدات أصغر

• قم بتقسيم الكود إلى دوال ووحدات أصغر لتسهيل القراءة والصيانة.
• استخدم الأسماء الوصفية للدوال والوحدات التي توضح غرضها.

مثال على كود Python يوضح أهمية كتابة كود واضح وسهل القراءة:

# كود غير مقروء
function(x, y, z)

# كود مقروء
def calculate_total(quantity, price, discount):
    return quantity * price * (1 - discount)