قسمت ۴: نوشتن کامنت در کدهای پایتون

کامنت (Comment) چیست و چه کاربردی دارد؟

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

چرا باید در کدهای خود کامنت بنویسیم؟

• توضیح دادن منطق کد: وقتی کدهای پیچیده‌ای می‌نویسید، با یک کامنت ساده مشخص می‌کنید که این قطعه کد دقیقاً قرار است چه کاری انجام دهد تا در آینده به راحتی آن را به یاد بیاورید.
• غیرفعال کردن موقت کدها برای دیباگ: هنگام تست برنامه یا پیدا کردن یک خطا (Bug)، می‌توانید به جای پاک کردن کد، موقتاً آن را تبدیل به کامنت کنید تا اجرا نشود.
• افزایش خوانایی پروژه: کدی که مستندسازی شده باشد، کار تیمی را به شدت آسان کرده و کدهای شما را استاندارد می‌کند.

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

در زبان پایتون به دو شکل کلی می‌توانیم توضیحات خود را به کدها اضافه کنیم:

۱. کامنت‌های یک خطی (Single-line Comments)

پرکاربردترین روش برای نوشتن کامنت، استفاده از علامت هشتگ (#) است. هر متنی که بعد از علامت # در یک خط نوشته شود، کامنت محسوب می‌شود.

# این یک پیام برای خودم است و در برنامه اجرا نمی‌شود
print("سلام دنیا") # این دستور اجرا می‌شود و متن را چاپ می‌کند

۲. کامنت‌های چند خطی (Multi-line Comments)

برای توضیحات طولانی، می‌توانید از سه علامت دابل‌کوتیشن (""") یا سینگل‌کوتیشن (''') در ابتدا و انتهای متن خود استفاده کنید:

"""
این یک کامنت چند خطی است.
شما می‌توانید توضیحات مربوط به پروژه،
راهنمای استفاده از کد و جزئیات دیگر را
اینجا به صورت کامل بنویسید.
"""

ترفند حرفه‌ای: کلید میانبر کامنت در VS Code

در ویرایشگر ویژوال استودیو کد (VS Code) نیازی نیست برای هر خط به صورت دستی علامت # را تایپ کنید. از کلیدهای میانبر زیر استفاده کنید:

نتیجه‌گیری

یادگیری نحوه استفاده درست از کامنت‌ها یکی از بهترین عادت‌هایی است که می‌توانید در خود پرورش دهید. همیشه سعی کنید کدهای خود را تمیز و با توضیحات کافی بنویسید. در جلسه بعدی وارد دنیای جذاب متغیرها (Variables) خواهیم شد.