کامنت ها در پایتون

ممکن است بخواهیم کدی که توسعه می‌دهیم را توضیح دهیم. ممکن است بخواهیم یادداشت‌هایی در مورد اینکه چرا و چطور یک بخش از اسکریپت عمل می‌کند، بنویسیم. ما از توضیحات یا کامنت ها برای انجام این کارها استفاده می‌کنیم. فرمول‌ها، روش‌ها و منطق تجاری پیچیده معمولاً با کامنت ها توضیح داده می‌شوند. وقتی برنامه اجرا می‌شود، مفسر پایتون کامنت ها را نادیده می‌گیرد و فقط اسکریپت را ترجمه می‌کند. در پایتون، سه نوع کامنت وجود دارد: کامنت تک خطی، کامنت چندخطی و رشته‌های اسنادی.

مزایای استفاده از کامنت

زمانی که از کامنت در کدمان استفاده می کنیم، کد ما قابل فهم‌تر می‌شود. این به ما کمک می‌کند تا به یاد داشته باشیم که چرا بخش‌های خاصی از کد ایجاد شده‌اند و باعث خوانایی بیشتر کد های ما می شود.

علاوه بر این، می‌توانیم از کامنت ها برای نادیده گرفتن بخش‌های خاصی از کد هنگام ارزیابی بخش‌های دیگر کد استفاده کنیم. این تکنیک ساده باعث می‌شود که برخی از خطوط اجرا نشوند یا برای برنامه یک کد سریع مجازی ایجاد شود.

در زیر، برخی از کاربردهای رایج کامنت ها در پایتون آورده شده‌اند:

• 1. افزایش قابلیت خوانایی کد
• 2. محدود کردن اجرای کد
• 3. ارائه یک مرور کلی از متادیتا برنامه یا پروژه
• 4. افزودن منابع به کد

انواع کامنت در پایتون

در پایتون، سه نوع کامنت وجود دارد که در زیر توضیح داده شده‌اند:

کامنت تک خطی (Single-Line Comments)

کامنت تک خطی در پایتون برای ارائه توضیحات سریع برای پارامترها، تعریف‌های توابع و عبارات مفید است. یک کامنت تک خطی در پایتون با داشتن علامت هشتگ (#) در ابتدای خود شروع می‌شود و تا انتهای خط ادامه دارد. اگر کامنت به خط بعدی ادامه دارد، علامت هشتگ به خط بعدی اضافه کرده و متن کامنت را ادامه دهید. به عنوان مثال کد زیر نحوه استفاده از یک کامنت تک خطی را نشان می‌دهد:

# This code is to show an example of a single-line comment  
print( 'This statement does not have a hashtag before it' )  

This statement does not have a hashtag before it

کامپایلر پایتون خط اول در کد فوق را نادیده گرفته و فقط خط دوم را نمایش داده است.

هر چیزی که بعد از # آمده است، حذف می‌شود. به عبارت دیگر، ما می‌توانیم برنامه مذکور را در یک خط قرار دهیم به صورت زیر:

print( 'This is not a comment' ) # this code is to show an example of a single-line comment  

This is not a comment

خروجی این برنامه مانند مثال بالا خواهد بود. کامپیوتر تمام محتوا را که بعد از # آمده است نادیده می‌گیرد.

کامنت چند خطی

پایتون امکان ایجاد کامنت چند خطی به صورت مستقیم ارائه نمی‌دهد. اما روش‌های زیادی برای ایجاد کامنت چند خطی وجود دارد.

با استفاده از چندین علامت هشتگ (#)

در پایتون، می‌توانیم از علامت هشتگ (#) چندین بار استفاده کنیم تا چندین خط کامنت را ایجاد کنیم. هر خط که در ابتدای آن یک علامت هشتگ (#) قرار داشته باشد، به عنوان یک کامنت تک خطی در نظر گرفته می‌شود.

# it is a  
# comment  
# extending to multiple lines  

در این مورد، هر خط به عنوان یک کامنت در نظر گرفته می‌شود و همه آنها نادیده گرفته می‌شوند.

استفاده از رشته‌های متنی (String Literals)

به دلیل این که پایتون عبارات متنی را که به متغیری اختصاص داده نشده‌اند نادیده می‌گیرد، می‌توانیم از آنها به عنوان کامنت استفاده کنیم.

'it is a comment extending to multiple lines'  

توجه داشته باشید که با اجرای این کد، هیچ خروجی‌ای تولید نمی‌شود. بنابراین، ما از رشته‌هایی که در داخل سه علامت نقل قول (" "" ) قرار دارند به عنوان کامنت چندخطی استفاده می‌کنیم.

رشته مستند پایتون (Python Docstring)

رشته‌های محصور در سه علامت نقل قول که فورا بعد از تعریف تابع مشخص شده‌اند، به عنوان رشته مستند پایتون شناخته می‌شوند. این رشته‌ها برای ایجاد ارتباط میان مستندات توسعه داده شده برای ماژول‌ها، متدها، کلاس‌ها و توابع پایتون طراحی شده‌اند. آنها زیر تابع، ماژول یا کلاس قرار داده می‌شوند تا توضیح دهند که چه عملی انجام می‌دهند. رشته مستند سپس با استفاده از ویژگی __doc__ در پایتون به راحتی قابل دسترسی است.

# Code to show how we use docstrings in Python  
  
def add(x, y):  
    """This function adds the values of x and y"""  
    return x + y  
   
# Displaying the docstring of the add function  
print( add.__doc__ )  

This function adds the values of x and y