الأربعاء، 23 أكتوبر 2024

طرق إنشاء تعليقات متعددة الأسطر في بايثون

 تحتوي لغات البرمجة الأخرى مثل C++ وJava وJavaScript على آلية مدمجة للتعليقات متعددة الأسطر، ولكن لا توجد آلية مدمجة للتعليقات متعددة الأسطر في Python. وبالتالي، لن يعمل الكود التالي:


1
2
3
4
5
/*
This is a multiline
Comment in
Python
*/

سيؤدي الكود أعلاه إلى ظهور خطأ في Python. ومع ذلك، لا تزال هناك بعض الحلول البديلة لاستخدام التعليقات متعددة الأسطر في Python. دعنا نلقي نظرة على الطرق المختلفة للقيام بذلك في هذه المقالة.

معلومات سريعة عن التعليقات:

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

ما هو التعليق متعدد السطور في بايثون؟

التعليق متعدد الأسطر في بايثون هو تعليق يتوسع بشكل عام إلى أسطر متعددة، أي أن التعليقات متعددة الأسطر هي التعليقات التي تتوسع إلى سطرين أو أكثر في الكود المصدر.

الطريقة 1: استخدام تعليقات متعددة على سطر واحد

يمكننا استخدام التعليقات المتعددة ذات السطر الواحد لإنشاء تعليقات متعددة الأسطر في بايثون. ولكن أولاً، يجب أن تعرف كيفية عمل تعليق ذي سطر واحد في بايثون. يتم استخدام علامة التجزئة (#) لعمل تعليقات ذات سطر واحد في بايثون. لا يتم طباعة السطر المُعلَّق عليه في الإخراج.

1
2
# print("Hello Finxters")
print("Learning to create multiline comments in Python")

الناتج:

1
Learning to create multiline comments in Python

الآن دعنا ننشئ تعليقات متعددة الأسطر باستخدام تعليقات متتالية ذات سطر واحد:

1
2
3
4
5
6
print("Learning to create multiline comments in Python")
# print("Hello Finxters")
# print("This is a")
# print("Multiline comment")
# print("in Python")
print("End of program")

الناتج:

1
2
Learning to create multiline comments in Python
End of program

كما نرى أن المحلل في بايثون يتجاهل الأسطر التي تم التعليق عليها، مما يؤدي إلى إنشاء كتلة من التعليقات.

إن استخدام التعليقات ذات السطر الواحد لتعليق كل سطر من تعليق متعدد الأسطر بشكل فردي يصبح عملية شاقة للغاية. وبالتالي لا يُنصح باستخدام هذه الطريقة عندما لا تستخدم أي محرر حديث. ومع ذلك، فإن معظم محرري التعليمات البرمجية الجدد لديهم اختصار للتعليق على الكتل في Python. يمكنك فقط تحديد بضعة أسطر من التعليمات البرمجية باستخدام مفتاحي Shift والمؤشر ثم الضغط على cmd + / (قد يختلف هذا الاختصار حسب المحرر الذي تستخدمه) للتعليق عليها جميعًا مرة واحدة. يمكنك حتى إلغاء التعليق عليها بسهولة عن طريق تحديد كتلة التعليقات والضغط على اختصار لوحة المفاتيح cmd + /.

الطريقة 2: استخدام سلاسل الوثائق أو سلاسل متعددة الأسطر

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

1) سلاسل توثيقية مكونة من سطر واحد
2) سلاسل توثيقية متعددة الأسطر.

لإنشاء تعليق كتلة، نستخدم سلاسل توثيق متعددة الأسطر. دعنا ننشئ تعليقات متعددة الأسطر باستخدام سلاسل توثيق في المثال التالي:

1
2
3
4
5
6
7
8
print("Learning to create multiline comments in Python")
'''
print("Hello Finxters")
print("This is a")
print("Multiline comment")
print("in Python")
'''
print("End of program")

الناتج:

1
2
Learning to create multiline comments in Python
End of program

المثال 2: افترض أنك تريد تعريف تعليق كتلة داخل دالة باستخدام سلاسل الوثائق، فيجب عليك القيام بذلك بالطريقة التالية:

1
2
3
4
5
6
7
8
9
def multiply(x, y):
    res = x * y
    """
    This is a multiline comment indented properly
    This function returns the result
    after multiplying the two numbers
    """
    return res
print("The multiplication of the two numbers is", multiply(10, 5))

الناتج:

1
The multiplication of the two numbers is 50

تحذير:

  • يجب عليك دائمًا التأكد من أنك استخدمت المسافة البادئة لـ """ الأولى بشكل صحيح؛ وإلا، فقد تحصل على SyntaxError.
  • أيضًا، إذا كنت تفتح تعليقًا متعدد الأسطر باستخدام ثلاث علامات اقتباس مزدوجة """، فيجب عليك التأكد من إحاطة الكتلة بثلاث علامات اقتباس مزدوجة أيضًا. إذا لم تتبع هذه الاتفاقية، فستتلقى خطأً مرة أخرى. على سبيل المثال – إذا فتحت تعليقًا متعدد الأسطر بثلاث علامات اقتباس مزدوجة وأغلقته باستخدام ثلاث علامات اقتباس مفردة، فستتلقى خطأً.

المثال الأول: إذا لم تقصد """ بشكل صحيح، فقد تحصل على الخطأ التالي:

1
2
3
4
5
6
7
8
9
def multiply(x, y):
    res = x * y
"""
    This is a multiline comment indented properly
    This function returns the result
    after multiplying the two numbers
    """
    return res
print("The multiplication of the two numbers is", multiply(10, 5))

الناتج:

1
2
3
4
File "main.py", line 10
    return res
    ^
IndentationError: unexpected indent

المثال الثاني: دعنا نتصور ما يحدث عندما يكون هناك عدم تطابق بين نوع علامات الاقتباس الثلاثية المستخدمة.

1
2
3
4
5
6
7
8
9
def multiply(x, y):
    res = x * y
    """
    This is a multiline comment indented properly
    This function returns the result
    after multiplying the two numbers
    '''
    return res
print("The multiplication of the two numbers is", multiply(10, 5))

الناتج:

1
2
3
4
  File "C:\Users\SHUBHAM SAYON\PycharmProjects\General\rough.py", line 10
    print("The multiplication of the two numbers is", multiply(10, 5))
                                                                      ^
SyntaxError: EOF while scanning triple-quoted string literal

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

1
2
3
4
5
6
7
8
9
10
11
def multiply(x, y):
    """
    This is a multiline comment made
    right after the function definition
    It now becomes a function docstring associated
    with the function object that is also
    accessible as runtime metadata
    """
    res = x * y
    return res
print("The multiplication of the two numbers is", multiply(10, 3))

الناتج:

1
The multiplication of the two numbers is 30

تعلمنا طريقتين لإنشاء تعليقات متعددة الأسطر في بايثون –

  • ➨استخدام التعليقات المتتالية المكونة من سطر واحد.
  • ➨سلاسل متعددة الأسطر (السلاسل الوثائقية).

هذا كل شيء في هذه المقالة. آمل أن تكون قد وجدتها مفيدة. يرجى البقاء على اطلاع والاشتراك للحصول على المزيد من المقالات والبرامج التعليمية الشيقة في المستقبل. تعلم سعيد!

في
التسميات:

ليست هناك تعليقات:

إرسال تعليق

الاشتراك في: تعليقات الرسالة (Atom)

جلب البيانات من صفحة ويب باستخدام Selenium

  في هذا الدرس، سننشئ أداة لاستخراج البيانات من أي موقع ويب باستخدام Selenium. Selenium هو مشروع مفتوح المصدر يستخدم لأتمتة المتصفحات. وهو ي...

  • كيفية إستخدام وحدة Random في بايثون
    برامج الكمبيوتر وخاصة الألعاب منها تكون ممتعة لو كانت هناك بعض من الأشياء العشوائية ولكن ولسوء الحظ ليس لدينا أي طريقة تمكننا من الاعتماد ع...
  • تثبيت مكتبة pygame لبرمجة الألعاب
    هل أنت هنا لأنك تريد أن تبرمج العاب الخاصة بك ! جيد لأنك في المكان المناسب ، لأنني بصدد كتابة بعض المواضيع حول برمجة الألعاب باستخدام لغة ...
  • كيفية إستعمال مكتبة PILLOW
    تعتبر مكتبة PIL  مكتبة للتعامل والتلاعب ومعالجة الصور بطريقة جد سهلة وممتعة كماأنها تدعم الكثير من صيغ الصور المختلفة ومشكلة هذه المكتبة أن...