آموزش پایتون به زبان ساده: توضیحات

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

کامنت (Comment) چیه؟

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

کاربردهای توضیحات در برنامه‌نویسی

کدنویسی تمیز (Clean Code)

درسته که کامپیوتر کدها رو اجرا می کنه، اما یه مساله‌ی دیگه‌ای که هست اینه که این کدها توسط برنامه‌نویسان و عوامل انسانی خونده میشن. پس لازمه که در بخش‌هایی از برنامه یه سری توضیحاتی رو بنویسیم که مثلا فلان بخش چه کاری رو انجام میده. کاربردش زمانی مشخص میشه که بعد از چند ماه دوباره سراغ اون کد میریم و متوجه میشیم که اینجای برنامه چیکار می‌کنه. همچنین توی کارهای گروهی خوندن برنامه ما توسط برنامه‌نویسای دیگه راحت‌تر میشه و اینجاست که مباحثی مثل کدنویسی تمیز یا Clean Code توی پروژه‌ها اهمیت پیدا می‌کنه و این موضوع هم به نفع شماست هم برنامه نویسای دیگه!

باگ‌یابی و رفع اشکال (Debugging)

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

# print welcome function
print(‘hello world’)

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

چند تا نکته:

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

print(‘hello world’) # print welcome function

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

# hello world
how are you?
print(‘hello world’)

و باید مثلا این طوری اصلاح بشه:

# hello world
# world function

کامنت‌های چندخطی

کامنت‌های چندخطی رو یه جور راحت‌تر دیگه هم میشه تعریف کرد و اونجوری مجبور نیستیم که برای هر خط، # بذارین.
به این صورت که کامنت‌های خودتون چه یه خط چه صد خط! بین ۳ تا علامت نقل‌قول قرار بگیرن. هم علامت نقل‌قولی تکی میتونه هم دوتایی مثال:

”’
hello world
how are you?
”’
print(“Hello world”)

جمع بندی

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

این قسمت از آموزش هم به پایان رسید. امیدوارم که از این مقاله هم لذت برده باشین.

منبع: آموزش پایتون به زبان ساده: توضیحات - وبسایت شخصی محمدحسین میثاق‌پور