آموزش پایتون - کامنت‌ها

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

همه زبان‌های برنامه‌نویسی مدرن، از جمله پایتون، از دو نوع کامنت پشتیبانی می‌کنند: کامنت‌های یک خطی و کامنت‌های چند خطی یا بلوکی. کامنت‌های پایتون تا حدی به کامنت‌های موجود در زبان‌های برنامه‌نویسی دیگر مانند PHP، BASH و Perl شباهت دارند.

سه نوع کامنت در پایتون وجود دارند:

• کامنت‌های یک خطی
• کامنت‌های چندخطی
• کامنت‌های Docstring

کامنت‌ها یک خطی

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

مثال

مثالی از کامنت یک خطی در پایتون عبارت زیر است:

# This is a single line comment in python

print ("Hello, World!")

این عبارت نتیجه زیر را تولید می‌کند:

Hello, World!

می‌توانید یک کامنت را در همان خط پس از یک دستور وارد کنید:

name = "Madisetti" # This is again comment

کامنت‌ها چندخطی

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

# This is a comment.
# This is a comment, too.
# This is a comment, too.
# I said that already.

رشته‌ی سه‌گانه زیر نیز توسط مفسر پایتون نادیده گرفته می‌شود و می‌تواند به عنوان کامنت چندخطی استفاده شود:

'''
This is a multiline
comment.
'''

مثال

مثال زیر نمونه‌ای است برای نمایش استفاده از کامنت‌ها چندخطی:

'''
This is a multiline
comment.
'''

print ("Hello, World!")

این عبارت نتیجه زیر را تولید می‌کند:

Hello, World!

کامنت‌ها Docstring

داک استرینگ (docstring) در پایتون یک راه ساده برای ارائه مستندات راهنما برای ماژول‌ها، توابع، کلاس‌ها و متدها فراهم می‌کند. داک استرینگ (docstring) از طریق ویژگی __doc__ در دسترس قرار می‌گیرد.

def add(a, b):
    """Function to add the value of a and b"""
    return a+b

print(add.__doc__)

این عبارت نتیجه زیر را تولید می‌کند:

Function to add the value of a and b