کامنت‌ها نتیجه برنامه را تغییر نمی‌دهند، اما قطعاً کارها را آسان‌تر می‌کنند! اگر تازه با زبان برنامه‌نویسی زیبای پایتون آشنا شده‌اید (خوش آمدید!)، احتمالاً تا به حال هرگز کامنتی ننوشته‌اید. اگر صادقانه بگوییم، احتمالاً حتی مطمئن نیستید که کامنت‌ها برای چه هستند. اما اگر می‌خواهید در کدنویسی بهتر شوید، علاوه بر دریافت میزبانی وب عالی، تا بتوانید تمرین ساخت وب‌سایت داشته باشید، باید یاد بگیرید که از عملکرد کامنت در پایتون استفاده کنید.
در این راهنما، ما همه چیزهایی را که برای درک کامنت پایتون نیاز دارید، توضیح می‌دهیم تا بتوانید مانند یک حرفه‌ای به نظر برسید، حتی اگر تازه شروع کرده‌اید.
کامنت پایتون چیست؟
کامنت متنی است که نتیجه کد را تغییر نمی‌دهد؛ فقط به افراد (یا خود آینده‌تان) اطلاع می‌دهد که با یک بلوک کد چه کاری انجام می‌دهید. کامنت‌ها به طور کلی مفید هستند، اما هرچه کد شما طولانی‌تر باشد، تعداد افرادی که با آن کار می‌کنید بیشتر باشد و مدت زمانی که کد را رها می‌کنید تا دوباره به آن برگردید طولانی‌تر باشد، اهمیت آنها بیشتر می‌شود. (وقتی یک برنامه شصت صفحه‌ای دارید که یک سال آن را رها کرده‌اید، نمی‌توانید نام هر متغیر را به خاطر بیاورید.)
چرا از کامنت پایتون استفاده کنیم؟
اگر تا به حال فقط به تنهایی کار کرده‌اید و هرگز کدی را به اندازه کافی طولانی رها نکرده‌اید تا برنامه‌های خود را برای آن فراموش کنید، احتمالاً اهمیت نوشتن کامنت پایتون را درک نمی‌کنید. اما وقتی شروع به کار روی پروژه‌های متعدد می‌کنید و رشته‌های کد را روی کامپیوتر خود رها می‌کنید، اوضاع می‌تواند به سرعت گیج‌کننده شود.
نوشتن کامنت‌ها به شما کمک می‌کند تا بدون از دست دادن ریتم، به پروژه‌های قدیمی بازگردید.
و این یادداشت‌ها برای هر کسی که با شما همکاری می‌کند نیز بسیار مفید هستند. به جای اینکه هر پنج دقیقه یک بار به شما پیام بدهند تا درباره دیدگاه شما برای کدتان بپرسند، می‌توانند کامنت‌های شما را بخوانند و کاملاً در جریان قرار بگیرند!
۸ روش برتر برای استفاده از کامنت پایتون
دو دلیل اصلی برای افزودن کامنت پایتون وجود دارد.
۱. مستندسازی کار خود
اولین دلیل این است که مستند کنید چه کاری انجام می‌دهید تا وقتی بعداً کد خود را می‌خوانید، آن را درک کنید.
۲. توضیح کار خود
دومین دلیل این است که توضیح دهید چه کاری انجام می‌دهید تا سایر برنامه‌نویسان بتوانند کد شما را درک کنند.
بهترین روش این است که هنگام نوشتن کد، کامنت‌های مرتبط را بنویسید. در اینجا چند نکته دیگر که باید هنگام نوشتن کامنت‌ها به خاطر داشته باشید آورده شده است:
۳. کامنت‌ها باید به خط یا بلوک کدی که به آن اشاره می‌کنند، خاص باشند
اگر این قانون را رعایت نکنید، با تعداد زیادی کامنت نامرتبط مواجه خواهید شد و باید زمان زیادی را صرف تطبیق کامنت‌ها با قطعه کد مربوطه کنید.
۴. کامنت‌ها باید کوتاه و مرتبط باشند
کامنت‌ها جایی برای پرحرفی یا نوشتن نامه‌های طولانی نیستند. هدف از کامنت این است که به افراد کمک کند تا به سرعت با کد شما آشنا شوند. بنابراین، کامنت‌های خود را مختصر و مفید نگه دارید.
۵. کامنت‌ها باید فقط در صورت لزوم اضافه شوند
اگر یک خط کد خود توضیح‌دهنده است، نیازی به افزودن کامنت نیست. اما اگر یک متغیر را اعلام می‌کنید، می‌توانید توضیح دهید چرا این کار را انجام می‌دهید، زیرا ممکن است بلافاصله مشخص نباشد.
۶. کد حلقه‌ها را کامنت‌گذاری کنید
حلقه‌ها می‌توانند برای سایر برنامه‌نویسان کمی سخت‌تر باشند. بنابراین، از بلوک‌های کامنت برای توضیح حلقه و چگونگی تطبیق آن با برنامه کلی کد خود استفاده کنید.
۷. از کامنت‌ها برای توضیح توابع و متدهای کلاس استفاده کنید
این‌ها معمولاً بلوک‌های بزرگتری از کد هستند که عملکرد حیاتی دارند. برای سایر برنامه‌نویسان بسیار مفید است که دقیقاً بدانند تابع چه کاری انجام می‌دهد و چگونه می‌توان آن را با سایر قسمت‌های نرم‌افزار استفاده کرد.
۸. از استفاده از شوخی‌های نامناسب یا کلمات زشت خودداری کنید
البته، اگر مطمئن هستید که تنها کسی هستید که کد شما را می‌بیند، می‌توانید هر کامنتی که دوست دارید بنویسید. اما هرگز نمی‌دانید که در آینده با چه کسی ممکن است همکاری کنید و نمی‌خواهید ریسک کنید که زبان نامناسبی را شامل کنید، آن را فراموش کنید و سپس به طور تصادفی آن را به یک مربی نشان دهید. برای اطمینان، بهتر است کامنت‌های خود را از زبان نامناسب پاک نگه دارید.
اینجا نمونه‌ای از کامنت پایتون آورده شده است
نحو صحیح کامنت در پایتون
برای نوشتن یک کامنت در پایتون، با کاراکتر # شروع کنید. برای مثال:
python کامنت‌ها در پایتون همیشه با کاراکتر هش شروع می‌شوند
این کار به این دلیل انجام می‌شود که وقتی مفسر با یک نماد # در هر جایی روبرو می‌شود (به جز داخل یک رشته)، همه چیزی را که در کنار آن نوشته شده تا پایان خط نادیده می‌گیرد.
اگر بیش از یک خط کامنت دارید، همه آنها باید با # شروع شوند. برای مثال:
python
# همه کامنت‌ها در پایتون با کاراکتر هش شروع می‌شوند
# اگر بیش از یک خط وجود دارد، هش را به هر خط کامنت جدید اضافه کنید
برای کامنت کردن چندین خط، می‌توانید از این میانبر نیز استفاده کنید: کلید ctrl را نگه دارید و در هر جایی که می‌خواهید # اضافه کنید، کلیک چپ کنید. سپس، # را یک بار تایپ کنید. این کار تمام خطوطی را که کلیک چپ کرده‌اید، کامنت خواهد کرد.
نتیجه‌گیری
لازم نیست کد خود را با کامنت‌ها پر کنید، اما انکارناپذیر است که کامنت‌ها به سایر برنامه‌نویسان کمک می‌کنند تا کد شما را درک کنند. آنها حتی به شما کمک می‌کنند تا کد خودتان را درک کنید اگر مجبور شوید آن را برای مدتی رها کنید تا روی پروژه‌های دیگر کار کنید. اگر کامنت‌های خود را منظم نگه دارید و همزمان با کدنویسی کامنت بگذارید، می‌توانید زمان زیادی را صرفه‌جویی کنید.
