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

مقدمه

امکان درج توضیحات (comments) در بین کدها یک ویژگی بسیار مفید در هر زبان برنامه‌نویسی و از جمله پایتون است. در مثال‌های ساده‌ای که تا اینجا دیدیم، استفاده از کامنت‌ها نه لطفی داشت و نه ضرورتی. اما با بزرگتر و پیچیده‌تر شدن برنامه‌ای که در حال نوشتن آن هستید، نیاز پیدا می‌کنید که نکات و توضیحاتی را در برنامه وارد کنید و رویکرد کلی حل مسائل بخش‌های مختلف برنامه را مستند کنید. کامنت‌ها به ما امکان می‌دهند که توضیحات مورد نظرمان را در هر بخشی از برنامه وارد کنیم و مفسر پایتون آنها را نادیده می‌گیرد.

نحوه نوشتن کامنت‌ها

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

PYTHON

# Say hello to everyone!
print("Hello Python People!")

در اینجا پایتون خط اول را نادیده گرفته و نیتجه‌ی زیر را تولید می‌کند:

اهمیت کامنت‌ها

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

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

از اینجا به بعد، از کامنت‌ها در مثال‌هایی که ارائه می‌شود، استفاده می‌کنیم تا مهارت نوشتن کامنت در شما تقویت شود.