دستور، تورفتگی و کامنت در پایتون

در این مقاله، ما درباره دستور‌ها (statement)، تورفتگی (Indentation)، و کامنت (نظر – comment) در پایتون صحبت خواهیم کرد. همچنین در مورد قوانین و مثال‌های مختلف آنها صحبت می کنیم، و تفاوت بین ‘رشته‌های اسنادی’ (Docstrings) و ‘کامنت های چندخطی’ را نیز بررسی می کنیم.

دستور (statement) در پایتون چیست؟

یک دستور پایتون، دستورالعملی است که مفسر پایتون می‌تواند اجرا کند. انواع مختلفی از دستور‌ها در زبان پایتون وجود دارد مانند دستور‌های انتصاب، دستور‌های شرطی، دستور‌های حلقه و غیره. کاراکتر NEWLINE (یعنی شروع یک خط جدید) برای پایان دادن به یک دستور در پایتون استفاده می‌شود. این نشان می‌دهد که هر خط از یک اسکریپت پایتون حاوی یک دستور است.

همه این‌ها به کاربر کمک می‌کنند تا خروجی مورد نیاز خود را بدست آورد.

انواع دستور‌ها در پایتون

انواع مختلف دستور‌های پایتون در زیر فهرست شده‌اند:

– دستور‌های چند خطی

– دستور‌های شرطی و حلقه پایتون

   – If-else

   – حلقه for 

   – حلقه while 

   – دستورات try-except

   – with 

– دستور‌های عبارتی پایتون

   – pass 

   – del 

   – return 

   – import 

   – continue 

   – break 

مثال:

دستور‌ها در پایتون می‌توانند با استفاده از پرانتزها ()، کروشه‌ها {}، براکت‌های مربعی[]، نقطه‌ویرگول (;) و نشانه ادامه خط (\)، به چندین خط تقسیم شوند. هنگامی که برنامه‌نویس برای انجام محاسبات طولانی نیاز به فضای بیشتری دارد و نمی‌تواند تمامی دستور‌های خود را در یک خط بگنجاند، می‌تواند از این نمادها استفاده کند.

Declared using Continuation Character (\):
s = 1 + 2 + 3 + \
    4 + 5 + 6 + \
    7 + 8 + 9

Declared using parentheses () :
n = (1 * 2 * 3 + 7 + 8 + 9)

Declared using square brackets [] :
footballer = ['MESSI',
          'NEYMAR',
          'SUAREZ']

Declared using braces {} :
x = {1 + 2 + 3 + 4 + 5 + 6 +
     7 + 8 + 9}

Declared using semicolons(;) :
flag = 2; ropes = 3; pole = 4

تورفتگی در پایتون چیست؟

در پایتون برای تورفتگی از فضای خالی (Whitespace) استفاده می‌شود. برخلاف بسیاری از زبان‌های برنامه‌نویسی دیگر که تنها برای خوانایی بهتر کد به کار می‌روند، تورفتگی در پایتون اجباری است. می‌توان با نگاه کردن به یک مثال از تورفتگی در پایتون، این موضوع را بهتر درک کرد.

نقش تورفتگی در پایتون

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

بیشتر زبان‌های برنامه‌نویسی مانند C، ++C، و جاوا از آکولادها { } برای تعریف یک بلوک کد مشخص استفاده می‌کنند. ولی یکی از ویژگی‌های متمایز پایتون، استفاده از تورفتگی برای برجسته کردن بلوک‌های کد است. تمام دستور‌هایی که به میزان یکسانی به سمت راست تورفتگی دارند، متعلق به یک بلوک کد هستند.

اگر بلوکی نیاز به تو در تو شدن بیشتری داشته باشد، به سادگی می توان آن را بیشتر به سمت راست تورفته کرد.

مثال 1:

خطوط print(‘Logging on to datayad…’) و print(‘retype the URL.’) دو بلوک کد جداگانه هستند. دو بلوک کد ایجاد شده در دستور if ما در این مثال، هر دو چهار فضای خالی تورفتگی دارند. و خط نهایی print(‘All set!’) تورفتگی ندارد، بنابراین متعلق به بلوک else نیست.

# Python indentation

site = 'gfg'

if site == 'gfg':
	print('Logging on to datayad...')
else:
	print('retype the URL.')
print('All set !')

خروجی:

...Logging on to datayad
!All set 

مثال 2:

برای نشان دادن یک بلوک کد در پایتون، باید هر خط از بلوک را با فضای خالی یکسان تورفته کنید.

دو خط کد در حلقه while هر دو چهار فضای خالی تورفتگی دارند. این تورفتگی برای نشان دادن اینکه یک دستور به کدام بلوک کد تعلق دارد، ضروری است. به عنوان مثال، j=1 و while(j<=5): تورفتگی ندارند و بنابراین درون بلوک while نیستند. ساختار کدهای پایتون به این شکل با تورفتگی مشخص می‌شوند. 

j = 1
while(j <= 5):
	print(j)
	j = j + 1

کامنت (نظر – comment) در پایتون چیست؟

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

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

کامنت‌ها اغلب به عنوان یک قرارداد برنامه‌نویسی مفید شناخته می‌شوند که در خروجی برنامه شرکت نمی‌کنند اما خوانایی کلی برنامه را بهبود می‌بخشند.

کامنت‌ها در پایتون با نماد هشتگ، #، شناسایی شده و تا انتهای خط ادامه دارند.

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

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

کامنت تک‌خطی در پایتون

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

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

مثال 1:

پایتون اجازه می‌دهد که کامنت‌ها در ابتدای خطوط قرار گیرند، و مفسر پایتون تمام آن خط را نادیده می‌گیرد.

# This is a comment
# Print “datayad” to console
print("datayad")

خروجی:

datayad

مثال 2:

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

a, b = 1, 3 # Declaring two integers
sum = a + b # adding two integers
print(sum) # displaying the output

خروجی:

4

کامنت چندخطی در پایتون

برای نوشتن کامنت چندخطی در پایتون، هر خط باید با یک هشتک (#) شروع شود. و پایتون به صورت پیش‌فرض کامنت چندخطی را پشتیبانی نمی‌کند. اما، می‌توانیم از رشته‌های چندخطی برای این منظور استفاده کنیم.

اما این رشته‌ها با سه علامت نقل‌قول مضاعف (“””) یا سه علامت نقل‌قول تکی (”’) در ابتدا و در انتهای کامنت مورد نظر، محصور می‌شوند و نباید فاصله‌ای بین علامت های نقل قول باشد. این نوع کامنت‌ها وقتی کاربرد دارند که متن مورد نظر نیاز به چند خط دارد.

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

مثال 1:

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

# This is a comment
# This is second comment
# Print “datayad” to console
print("datayad")

خروجی:

datayad

مثال 2:

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

"""
This would be a multiline comment in Python that
spans several lines and describes datayad.
A Computer Science portal for geeks. It contains 
well written, well thought 
and well-explained computer science 
and programming articles, 
quizzes and more. 
…
"""
print("datayad")

خروجی:

datayad

مثال 3:

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

'''This article on datayd gives you a 
perfect example of
multi-line comments'''

print("datayad")

خروجی:

datayad

رشته‌های اسنادی در پایتون

رشته‌های اسنادی (Docstrings) در پایتون نوعی کامنت هستند که برای نمایش نحوه کارکرد برنامه استفاده می‌شوند. رشته‌های اسنادی در پایتون با سه علامت نقل‌قول (“”” “””) احاطه می‌شوند. رشته‌های اسنادی نیز توسط مفسر نادیده گرفته می‌شوند.

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

رشته‌های اسنادی و کامنت‌های چندخطی ممکن است شبیه به هم به نظر برسند، اما متفاوت هستند.

– رشته‌های اسنادی در توابع و کلاس‌ها برای نشان دادن نحوه استفاده از برنامه نوشته می‌شوند.

– کامنت‌های چندخطی برای نمایش نحوه کارکرد یک بلوک کد استفاده می‌شوند.