چگونه کدهای زبان برنامه نویسی پایتون را کامنت کنیم؟ کامنت گذاشتن در پایتون

اگر می خواهید به دیگران هنگام نوشتن کدهای پایتون کمک کنید تا کدهایی را که شما نوشتید به راحتی قابل خواندن باشد، اظهارنظر در مورد کد شما مهم است این امر چگونگی اظهارنظر در پایتون را در صورت کار در یک تیم بزرگ بسیار مهم می کند.

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

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

نحوه کامنت کردن کد در پایتون

خبر خوب این است که کامنت گذاشتن در پایتون بسیار آسان است. شما فقط باید آنچه را که می خواهید با یک هشتگ تایپ کنید ، مانند:

#This is a comment!

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

یادگیری نحوه کامنت کردن کد در پایتون آسان است ، پس؛ نکته سخت این است که بدانید چه موقع کامنت بگذارید و چگونه اطمینان حاصل کنید که این کامنت ها خوانا و مفید هستند.

طبق راهنمای سبک برای کد پایتون، شما باید هدف خود را حفظ کنید تا کامنت خود را زیر ۷۹ کاراکتر در هر سطر نگه دارید. این امر باعث می شود تا خواننده نیازی به حرکت افقی نداشته باشد و همه چیز را مرتب نگه دارد.

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

مثلاً کد زیر گیج کننده است:

if baddyX + 40 > mineX and baddyY + 40 > mineY and baddyX < mineX + 0 and baddyY < mineY + 19: #Checks the position of the bad guy in relation to the mine baddyX = 10000 #Sets the position of the bad guy to be far off the screen out of site pygame.display.update() #Updates the graphics reflecting the new positions

for event in pygame.event.get(): #Looks for an event
if event.type == pygame.QUIT: #If the event is the player clicking the cross run = False

چه موقع در پایتون کامنت بزاریم؟

کامنت گذاشتن در هر مکان اشتباه است، بلکه شما باید بدانید چه زمانی و در چه مکانی کامنت در پایتون بزارید. برای کامنت گذاشتن برخی از رایج ترین مکان و مفید زمان برای افزودن به کد خود عبارتند از:

• در مورد عملکرد کد و انچه انجام می دهد.
• توضیحی در مورد متغیر یا مجموعه متغیرها.
• توضیح در باره واضح نبودن کد،
• قسمت های مهم کد خود را برجسته کنید
• هشدارها

نکات مفید برای کامنت گذاشتن:

• کامنت ها را خلاصه قرار دهید.
• کدهایی که واضح است ، را کامنت نگذارید.
• بیش از حد کامنت نگذارید.
• فقط توضیح ندهید که چه کاری انجام می شود: توضیح دهید که چرا آن را در آنجا قرار داده اید و چرا مهم است.
• با دقت و کاملا خوانا کامنت بگذارید.

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

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

برای مثال ، توضیحات هدر در بالای فایل قرار دارد و می تواند به توضیح کد زیر است کمک کند. این حتی می تواند شامل برخی از راهنمایی های مفید باشد که به خواننده در یافتن کارکردهای مهم کمک می کند.

همچنین می توان از کامنت هدر به عنوان مکانی برای درج آگهی خود استفاده کرد. یکی دیگر از کاربردهای نظرات پایتون این است که به شما کمک کند سریع با استفاده از ابزار جستجو ، کد مورد نظر خود پیدا کنید. من اغلب در بین کدها کامنت می گذارم تا بتوانم سریعاً بین بخش های مختلف کد خود پرش کنم یا به عنوان روشی برای علامت گذاری کاری که بعداً باید انجام دهم.

اگر کدی را ناتمام بگذارم ، اغلب در آنجا کامنت می کنم ، تا بعداً بتوانم به راحتی آن را پیدا کنم.