مقدمة إلى التعليقات وقابلية قراءة التعليمات البرمجية

تُستخدم التعليقات لشرح التعليمات البرمجية وجعلها أسهل قراءة. ويتجاهلها مفسر Python ولا تؤثر في تنفيذ البرنامج.

ستتعلمون في هذا الدرس كيفية استخدام التعليقات وكتابة تعليمات برمجية نظيفة وسهلة القراءة.

التعليقات أحادية السطر

تبدأ التعليقات أحادية السطر بالرمز #. وتتجاهل Python كل ما يأتي بعد الرمز # في ذلك السطر. على سبيل المثال:

# This is a single-line comment
print("Hello, World!")

التعليقات متعددة الأسطر

يمكن كتابة التعليقات متعددة الأسطر باستخدام علامات الاقتباس الثلاثية (''' أو """). على سبيل المثال:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

لماذا نستخدم التعليقات؟

تساعد التعليقات في ما يلي:

• شرح التعليمات البرمجية المعقدة.
• جعل التعليمات البرمجية أسهل فهمًا للآخرين ولكم مستقبلًا.
• تصحيح الأخطاء واستكشاف المشكلات وإصلاحها.

تذكّروا أن التعليقات مخصصة للبشر، وليست للآلة!

ممارسات التعليق الجيدة

إليكم بعض النصائح لكتابة تعليقات جيدة:

• اجعلوا التعليقات موجزة وذات معنى.
• تجنبوا التعليقات الواضحة مثل # Increment x by 1 عند استخدام x = x + 1.
• استخدموا التعليقات لشرح سبب كتابة التعليمات البرمجية بطريقة معينة.

تحسين قابلية قراءة التعليمات البرمجية

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

• استخدموا أسماء واضحة للمتغيرات والدوال.
• اجعلوا أسطر التعليمات البرمجية قصيرة.
• نظّموا التعليمات البرمجية في أقسام باستخدام التعليقات.

تعطيل التعليمات البرمجية بالتعليق

يمكنكم استخدام التعليقات لتعطيل التعليمات البرمجية مؤقتًا لأغراض تصحيح الأخطاء. على سبيل المثال:

# print("This line is commented out and won’t run.")
print("This line will run.")

مثال: توثيق دالة

يمكنكم استخدام التعليقات لتوثيق الدوال وشرح الغرض منها:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

ماذا تعلمنا؟

في هذا الدرس، تعلّمت:

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

أحسنت! لننتقل إلى الموضوع التالي.