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

كيف تكتب تعليقات في بايثون

في Python ، هناك طريقتان للتعليق على الكود الخاص بك.

الأول هو تضمين التعليقات التي تفصل أو تشير إلى ما يفعله جزء من التعليمات البرمجية – أو المقتطف -.

الثاني يستخدم التعليقات أو الفقرات متعددة الأسطر التي تعمل كتوثيق للآخرين الذين يقرؤون التعليمات البرمجية الخاصة بك.

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

يتم إنشاء التعليقات أحادية السطر ببساطة عن طريق بدء سطر بحرف التجزئة (#) ، ويتم إنهاؤها تلقائيًا بنهاية السطر.

على سبيل المثال:

#This would be a comment in PythonCode language: PHP (php)

التعليقات التي تمتد على عدة أسطر – تُستخدم لشرح الأشياء بمزيد من التفصيل – يتم إنشاؤها عن طريق إضافة محدد (“”) في نهاية كل تعليق.

""" 
This would be a multiline comment
in Python that spans several lines and
describes your code, your day, or anything you want it to
""" Code language: PHP (php)

يرجى الملاحظة: الطريقة الموصى بها للتعليق على أسطر متعددة هي استخدام # في كل سطر. الطريقة (“”) ليست في الواقع تعليقًا ولكنها تحدد ثابت نص للنص بين (“” “). لا يتم عرضه ، ولكنه موجود وقد يتسبب في حدوث أخطاء غير متوقعة.

تذكر أن تعلق في كثير من الأحيان قدر الإمكان. من المهم!