نظرات (Comments) در پایتون به منظور توضیح و مستندسازی کد مورد استفاده قرار میگیرند. این نظرات به درک بهتر عملکرد بخشهای مختلف کد کمک میکنند، اما هیچگونه تأثیری در اجرای برنامه ندارند. در پایتون، برای نوشتن نظر از نماد #
(که به آن octothorpe یا علامت هش نیز گفته میشود) استفاده میشود. هر متنی که پس از این علامت در همان خط قرار گیرد، توسط مفسر نادیده گرفته خواهد شد:
x = 365
y = 7
# این یک نظر است
print(x % y) # محاسبه باقیمانده
# print(x // y)
# نظر دیگر
خروجی:
1
نکته: در پایتون بر خلاف برخی زبانهای دیگر مانند C یا Java، ساختار مستقلی برای نظرات چندخطی وجود ندارد. اگر بخواهید چند خط را بهعنوان نظر علامتگذاری کنید، باید در ابتدای هر خط از #
استفاده نمایید.
با این حال، پایتون از ساختاری به نام Docstring یا رشته مستندات پشتیبانی میکند که برای مستندسازی توابع، کلاسها و ماژولها طراحی شدهاند. این رشتهها با سه علامت نقلقول (تکی یا دوتایی) شروع و پایان مییابند و بلافاصله پس از تعریف تابع یا کلاس قرار میگیرند:
def shout(word):
"""
یک کلمه را با علامت تعجب چاپ میکند.
"""
print(word + "!")
shout("spam")
خروجی:
spam!
نکته: برخلاف نظرات معمولی، Docstringها در زمان اجرای برنامه در حافظه باقی میمانند و از طریق ویژگی __doc__
قابل دسترسی هستند. این ویژگی به برنامهنویس یا ابزارهای مستندسازی کمک میکند تا بتوانند توضیحات کد را در زمان اجرا مشاهده کنند.
print(shout.__doc__)
خروجی:
یک کلمه را با علامت تعجب چاپ میکند.