آموزش برنامه نویسی

توضیحات

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

#This line will print the message hello world
print("Hello World!")

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

#This line will print
#the message hello world
print("Hello World!")

یکی روش دیگر برای ایجاد توضیحات چند خطی به صورت زیر است:

''' This is a multiline 
Python comment example.'''
print("Hello World!")

همانطور که مشاهده می کنید، سه علامت کوتیشن قبل و سه علامت کوتیشن بعد از توضیحات قرار داده ایم. البته به جای سه علامت کوتیشن می توان از سه علامت جفت کوتیشن (“) هم استفاده کرد.