وقتی کد مینویسیم، خیلی وقتها لازمه داخل برنامه توضیحاتی بنویسیم تا خودمون یا بقیه برنامهنویسها راحتتر بفهمن هر بخش از کد دقیقاً چه کاری انجام میده.
به این توضیحاتی که داخل کد مینویسیم کامنت (Comment) گفته میشه.
نکته مهم اینه که کامنتها اصلاً توسط پایتون اجرا نمیشن و فقط برای خواناتر شدن کد استفاده میشن.
چرا توی کد کامنت مینویسیم؟
کامنتها کاربردهای مهمی دارن، از جمله:
- توضیح دادن کاری که یک بخش از کد انجام میده
- کمک به فهم بهتر کد در آینده (حتی برای خودمون!)
- کمک به بقیه برنامهنویسها برای درک برنامه
- گذاشتن یادداشت یا نکته داخل کد
وقتی پروژهها بزرگتر میشن، وجود کامنتها میتونه فهم کد رو خیلی راحتتر کنه.
نوشتن کامنت در پایتون
برای نوشتن کامنت در پایتون از علامت # استفاده میکنیم.
هر چیزی که بعد از این علامت نوشته بشه، توسط پایتون نادیده گرفته میشه و اجرا نمیشه.
مثال:
# این یک کامنت است
print("Hello")
در این مثال فقط دستور print اجرا میشود و متن کامنت هیچ تأثیری در اجرای برنامه ندارد.
استفاده از کامنت کنار کد
گاهی کامنت را در کنار یک خط کد مینویسیم تا توضیح بدهیم آن خط چه کاری انجام میدهد.
print("Hello") # نمایش یک متن در خروجی
مثال ساده
# نمایش نام
print("Arman")
# نمایش شهر
print("Tehran")
کامنتها باعث میشن هر کسی که کد رو میخونه، خیلی سریعتر بفهمه هر قسمت از برنامه چه کاری انجام میده.
نکته مهم
کامنت نوشتن کار خوبیه، اما نباید توش افراط کرد.
اگه کد تمیز و قابل فهم نوشته شده باشه، معمولاً به کامنتهای زیاد احتیاج نداره.
کامنتها بیشتر وقتی کاربردی هستن که بخوایم منطق یک بخش از برنامه رو توضیح بدیم، نه چیزهای کاملاً واضح.
تمرین ✅
یک برنامه بنویسید که:
- نام شما را چاپ کند
- سن شما را چاپ کند
و برای هر خط از کد، یک کامنت توضیحی بنویسید.
