التعليقات الكتلية
الدرس 6 من 28 في دورة Clean Code - كتابة كود أفضل باستخدام Python على Coddy.
“إذا كان من الصعب شرح التنفيذ، فهي فكرة سيئة.”
- زن بايثون (The Zen of Python)
التعليقات مهمة حتى يتمكن أي شخص يقرأ كودك من فهمه.
تنقسم التعليقات في بايثون إلى 3 أنواع:
- تعليقات الكتل (Block Comments)
- التعليقات المضمنة (Inline Comments)
- سلاسل التوثيق النصية (Documentation Strings)
لنبدأ بـ تعليقات الكتل (Block Comments) -
- تبدأ من نفس مستوى الإزاحة (indent) لكتلة الكود التي تصفها.
- تبدأ كل سطر بـ
#متبوعاً بمسافة واحدة.
على سبيل المثال،
while i < 10:
# التكرار عبر i حتى تصبح i < 10
# طباعة i مع سطر جديد وزيادتها بمقدار 1
print(i, '\n')
i += 1
التحدي
سهللقد تم إعطاؤك دالة greet، اكتب تعليقاً برمجياً (block comment) لوصف ما تفعله هذه الدالة - بأسلوبك الخاص.
اتبع القواعد!
جرّب بنفسك
def greet(name):
print('Hello', name)