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

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

در این درس از مجموعه آموزش برنامه نویسی سایت سورس باران، دستورات، تورفتگی ها و کامنت ها در برنامه نویسی پایتون (Statement, Indentation and Comments) را فرا خواهید گرفت.

پیشنهاد ویژه : پکیج آموزش صفر تا صد پایتون

دستورات (Statement) در برنامه نویسی پایتون

دستورالعمل هایی که یک مفسر پایتون می تواند اجرا کند، دستورات یا Statement نامیده می شوند. به عنوان مثال ، a = 1 یک عبارت انتساب است. دستورهای زیاد در برنام نویسی پایتون وجود دارد مانند: if، for، while و غیره انواع دیگری از گزاره ها هستند که بعدا مورد بحث قرار می گیرند.

دستورات چند خطی در برنامه نویسی پایتون 

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

a = 1 + 2 + 3 + \
    ۴ + ۵ + ۶ + \
    ۷ + ۸ + ۹

این یک ادامه خط صریح است. در پایتون،  می توان ادامه خط را در داخل پرانتز ()، کروشه  [] و آکولاد {}  که به صورت ضمنی است، نشان داد. به عنوان مثال، ما می توانیم دستور چند خطی بالا را به صورت زیر پیاده سازی کنیم:

a = (1 + 2 + 3 +
    ۴ + ۵ + ۶ +
    ۷ + ۸ + ۹)

در اینجا،  پرانتزها ( ) خط کد را به صورت ضمنی امتداد می‌دهند.  و همین شرایط نیر برای کروشه [] و آکولاد {} هم همینطور است. برای مثال می توان گفت:

colors = ['red',
          'blue',
          'green']

ما همچنین می توانیم چندین دستور را با استفاده از نقطه ویرگول در یک خط واحد قرار دهیم، به مثال زیر توجه کنید:

a = 1; b = 2; c = 3

تورفتگی در برنامه نویسی پایتون

اکثر زبان های برنامه نویسی مانند C ، C ++ و Java از braces برای تعریف یک کد از آکولاد {} استفاده می کنند. اما در پایتون از تورفتگی استفاده می شود.

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

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

for i in range(1,11):
    print(i)
    if i == 5:
        break

اعمال تورفتگی در پایتون باعث می شود که کد ظاهری شسته و رفته و تمیز داشته باشد. این منجر می شو برنامه های پایتون سازگار به نظر می رسند.

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

if True:
    print('Hello')
    a = 5

و

if True: print('Hello'); a = 5

هر دو کد درست هستند و یک کار را انجام می دهند، اما کد اولی واضح تر است.

• تورفتگی نادرست منجر به خطای IndentationError خواهد شد.

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

هنگام نوشتن برنامه، کامنت ها یا توضیحات بسیار مهم است. کامنت ها آنچه در داخل برنامه می گذرد را توصیف می کنند، بنابراین کسی که به سورس کد نگاه می کند برای فهمیدن آن مشکل ندارد.

ممکن است در مدت زمان یک ماه جزئیات اصلی برنامه ای را که به تازگی نوشتید فراموش کنید. بنابراین وقت گذاشتن برای توضیح این مفاهیم در قالب کامنت ها همیشه مثمر ثمر است.

در پایتون برای شروع کامنت نظر از علامت هش (#) استفاده می کنیم.

کامنت هابرای برنامه نویسان برای درک بهتر یک برنامه است. Python Interpreter نظرات را نادیده می گیرد.

#This is a comment
#print out Hello
print('Hello')

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

ما می توانیم کامنت هایی داشته باشیم که تا چندین خط گسترش یابد. یک راه استفاده از علامت هش (#) در ابتدای هر خط است. مثلا:

#This is a long comment
#and it extends
#to multiple lines

روش دیگر برای انجام این کار استفاده از نقل قول های سه گانه است، یا ”’ و یا ” ” “.

این نقل قول های سه گانه معمولاً برای رشته های چند خطی استفاده می شوند. اما می توان از آنها به عنوان یک نظر چند خطی نیز استفاده کرد. تا زمانی که «داک ‌استرینگ» (Docstrings) نباشد، هیچ کد اضافی تولید نمی کنند.

"""This is also a
perfect example of
multi-line comments"""

داک ‌استرینگ (Docstrings) در پایتون

یک داک ‌استرینگ (Docstrings) کوتاه رشته مستند سازی است.

docstrings پایتون مخفف «داکیومنتیشن استرینگ» (Documentation String) می باشد و عبارت های رشته ای هستند که درست پس از تعریف یک تابع، روش، کلاس یا ماژول ظاهر می شوند.

از نقل قول سه تایی هنگام نوشتن داک ‌استرینگ استفاده می شود. مثلا:

def double(num):
    """Function to double the value"""
    return 2*num

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

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

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

def double(num):
    """Function to double the value"""
    return 2*num
print(double.__doc__)

خروجی:

Function to double the value

منبع.

لیست جلسات قبل آموزش برنامه نویسی پایتون

1. آموزش نصب و اجرای برنامه نویسی پایتون
2. کلیدواژه ها و شناسه های برنامه نویسی پایتون