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

کامنت چیست؟

کامنت‌ها (Comments) یادداشت‌هایی هستند که در کد می‌نویسید اما پایتون آن‌ها را اجرا نمی‌کند. کامنت‌ها برای توضیح کد، یادآوری و مستندسازی استفاده می‌شوند.

کامنت تک‌خطی

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

# این یک کامنت است
print("سلام دنیا!")  # این هم یک کامنت است

کامنت در انتهای خط

می‌توانید بعد از کد، کامنت بنویسید:

x = 5  # تعریف متغیر x
y = 10  # تعریف متغیر y

کامنت چندخطی

پایتون کامنت چندخطی مجزا ندارد، اما دو راه وجود دارد:

راه ۱: چند #

# این خط اول توضیح است
# این خط دوم توضیح است
# این خط سوم توضیح است
print("کد اینجا")

راه ۲: رشته چندخطی (به‌عنوان کامنت)

"""
این یک رشته چندخطی است
که به‌عنوان کامنت استفاده می‌شود
پایتون آن را اجرا نمی‌کند (چون به متغیری اختصاص داده نشده)
"""
print("کد اینجا")

Docstring — مستندات تابع

Docstring نوع خاصی از کامنت است که بلافاصله بعد از تعریف تابع یا کلاس قرار می‌گیرد و کار آن را توضیح می‌دهد:

def greet(name):
    """این تابع یک پیام سلام نمایش می‌دهد.
    
    پارامترها:
        name: نام شخص
    """
    print(f"سلام {name}!")

می‌توانید docstring را با help() ببینید:

help(greet)

چرا از کامنت استفاده کنیم؟

1. توضیح کد پیچیده: منطق‌های پیچیده را توضیح دهید
2. یادآوری: بعداً یادتان باشد کد چه می‌کند
3. همکاری تیمی: دیگران کد شما را بفهمند
4. غیرفعال کردن کد: موقتاً کدی را اجرا نکنید

قوانین خوب کامنت‌نویسی

# محاسبه مالیات ۹ درصد
tax = price * 0.09

# ضرب قیمت در ۰.۰۹
tax = price * 0.09

کامنت خوب چرایی را توضیح می‌دهد، نه چگونگی!

غیرفعال کردن کد با کامنت

گاهی می‌خواهید موقتاً کدی را اجرا نکنید:

print("این اجرا می‌شود")
# print("این اجرا نمی‌شود")
print("این هم اجرا می‌شود")

انواع کامنت با کاربرد خاص

TODO — کارهای باقی‌مانده

# TODO: اعتبارسنجی ورودی را اضافه کن
# FIXME: این بخش با اعداد منفی مشکل دارد
# HACK: راه‌حل موقت، بعداً بازنویسی شود

کامنت منطقه‌ای (Region)

# ============================
# بخش ۱: تنظیمات اولیه
# ============================
config = load_config()

# ============================
# بخش ۲: پردازش داده
# ============================
process_data()

میانبرهای مفید

در VS Code:

• Ctrl + / (ویندوز) یا Cmd + / (مک): کامنت/عدم کامنت کردن خط انتخاب‌شده

خلاصه