توضیحات (Comments) در پایتون
توضیحات (Comments) در Python
آشنایی با نحوه نوشتن توضیحات و یادداشتها در کدهای پایتون
توضیحات (Comments) چیست؟
توضیحات یا Comments بخشهایی از کد هستند که توسط برنامه اجرا نمیشوند. از توضیحات برای توضیح عملکرد کد، یادداشتگذاری، افزایش خوانایی برنامه و کمک به برنامهنویسان استفاده میشود.
ایجاد یک توضیح در Python
در پایتون برای ایجاد یک توضیح تکخطی از علامت # استفاده میکنیم. هر چیزی که بعد از این علامت در همان خط قرار بگیرد، توسط پایتون اجرا نمیشود.
# This is a comment
print("Hello, World!")
در این مثال، خط اول فقط یک توضیح است و اجرا نمیشود. بنابراین خروجی برنامه فقط عبارت زیر خواهد بود:
Hello, World!
توضیحات برای توضیح کد
یکی از مهمترین کاربردهای Comments توضیح دادن عملکرد بخشهای مختلف برنامه است.
# Store the user's name
name = "Ali"
# Display the name
print(name)
توضیحات بالا باعث میشوند مشخص باشد هر قسمت از برنامه چه کاری انجام میدهد، بدون اینکه روی اجرای برنامه تأثیری داشته باشند.
توضیحات در انتهای یک خط
میتوان توضیح را در انتهای خطی که دارای کد است نیز قرار داد. کافی است قبل از توضیح علامت # قرار دهیم.
x = 10 # Store the value 10
print(x) # Display the value
در این مثال، کد قبل از علامت # اجرا میشود و قسمت بعد از آن به عنوان توضیح در نظر گرفته میشود.
جلوگیری موقت از اجرای یک خط
یکی دیگر از کاربردهای توضیحات، غیرفعال کردن موقت یک خط از کد است. برای این کار میتوان علامت # را ابتدای آن خط قرار داد.
print("First line")
# print("Second line")
print("Third line")
در این برنامه، دستور دوم با قرار گرفتن علامت # در ابتدای خط، اجرا نمیشود.
خروجی:
First line
Third line
توضیحات چندخطی
پایتون علامت مخصوصی برای Multiline Comments ندارد. با این حال، میتوان برای نوشتن توضیحات چندخطی، در ابتدای هر خط از علامت # استفاده کرد.
# This program calculates
# the sum of two numbers
# and displays the result.
a = 10
b = 20
print(a + b)
این روش، روش پیشنهادی و واضح برای نوشتن توضیحات چندخطی در کدهای پایتون است.
استفاده از Triple Quotes
در پایتون میتوان از رشتههای چندخطی با سه علامت نقلقول “”” یا ”’ نیز استفاده کرد.
"""
This is a
multi-line string.
"""
print("Hello")
این ساختار در واقع یک رشته چندخطی ایجاد میکند و یک Comment معمولی محسوب نمیشود. در بخشهای بعدی دوره، با کاربرد اصلی این نوع رشتهها بیشتر آشنا خواهید شد.
نکته مهم
توضیحات هیچ تأثیری بر اجرای برنامه ندارند و پایتون آنها را نادیده میگیرد. با این حال، استفاده درست از توضیحات باعث میشود کد خواناتر، قابل فهمتر و نگهداری آن آسانتر شود.
تمرین
برنامهای بنویسید که نام و سن یک فرد را در دو متغیر ذخیره کند و سپس آنها را نمایش دهد.
برای هر بخش از برنامه، یک توضیح مناسب با استفاده از علامت # بنویسید.
سپس یکی از دستورات print() را با استفاده از # موقتاً غیرفعال کنید.
جمعبندی
در این درس با Comments در Python آشنا شدیم. برای ایجاد توضیحات از علامت # استفاده میکنیم و میتوانیم توضیحات را در یک خط، انتهای یک دستور یا چند خط از برنامه قرار دهیم. همچنین دیدیم که میتوان با استفاده از این علامت، اجرای موقت یک خط از کد را نیز متوقف کرد.