آموزش نوشتن کامنت در پایتون

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

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

دوره پیشنهادی: دوره آموزش پایتون

 #  کامنت در پایتون

کامنت(comment) در پایتون خطوطی از کد هستند که در حین اجرای برنامه توسط کامپایلر نادیده گرفته می شوند. کامنت ها خوانایی کد را افزایش می دهد و به برنامه نویسان کمک می کند تا عملکرد کد را آسان تر درک کنند. سه نوع کامنت در پایتون وجود دارد:

• کامنت های تک خطی
• کامنت های چند خطی
• کامنت های docstring

به مثال زیر دقت کنید:

# Python program to demonstrate comments
 
# sample comment
name = "mongard"
print(name)

اگر مثال بالا را اجرا کنید نتیجه به شکل زیر خواهد بود:

mongard

در مثال بالا میتوان دید که کامنت ها توسط مفسر پایتون نادیده گرفته میشوند و هیچ تاثیری در عملکرد برنامه ندارند.

کامنت ها به طور کلی برای اهداف زیر استفاده می شود:

• افزایش خوانایی کد
• توضیح دادن نحوه کارکرد کد
• جلوگیری از اجرای بخشی از کد
• معرفی کردن منابع بیشتر

دقت کنید که کامنت ها برای برنامه نویسان هستند. کامنت ها قسمت هایی از کد را در صورت لزوم برای تسهیل درک برنامه نویسان، توصیف می کنند.

کامنت باید کوتاه، آسان و دقیق باشد. در حالی که PEP 8 توصیه می کند کد را با 79 کاراکتر یا کمتر در هر خط نگه دارید، حداکثر 72 کاراکتر را برای کامنت های درون خطی و docstring پیشنهاد می کند. اگر کامنت شما از 72 کاراکتر بیشتر شد، باید آن را در چندین خط پخش کنید.

مقاله پیشنهادی: آموزش کار با ماتریس(matrix) در پایتون

 #  کامنت های تک خطی در پایتون

کامنت های تک خطی پایتون با نماد هشتگ (#) شروع شده و تا انتهای خط ادامه می یابد. اگر کامنت از یک خط بیشتر شد، در ابتدای خط بعدی یک هشتگ دیگر قرار دهید و کامنت را ادامه دهید. کامنت های تک خطی پایتون برای ارائه توضیحات کوتاه برای متغیرها، توابع و عبارات، مفید است. قطعه کد زیر را ببینید که کامنت تک خطی را نشان می دهد:

# Print “mongard” to console
print("mongard")

در مثال بالا، یک کامنت مفید نوشتیم که نشان میدهد قرار است کلمه mongard را در کنسول نمایش دهیم.

مقاله پیشنهادی: ریز نکات پایتونی که همه باید بدانید

 #  کامنت های چند خطی در پایتون

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

می توانیم از چندین هشتگ (#) برای نوشتن کامنت های چند خطی در پایتون استفاده کنیم. هر خط به عنوان یک کامنت در نظر گرفته می شود:

# Python program to demonstrate
# multiline comments
print("Multiline comments")

روش دیگری که میتوانید برای ایجاد کردن کامنت های چند خطی در پایتون استفاده کنید، string literals است. پایتون رشته‌هایی را که به یک متغیر اختصاص داده نشده‌اند نادیده می‌گیرد، بنابراین می‌توانیم از این رشته‌ها به عنوان کامنت استفاده کنیم:

'This is a comment'
'This is another comment'
print('mongard')

ویدیو پیشنهادی: توضیح docstring در پایتون

 #  کامنت های docstring در پایتون

Docstring پایتون همان رشته‌هایی هستند که با نقل قول‌های سه‌گانه درست بعد از تابع ظاهر می‌شوند. برای مرتبط ساختن اسنادی که با ماژول ها، توابع، کلاس ها و متدهای پایتون نوشته شده اند استفاده می شود. docstring درست در زیر توابع، ماژول ها یا کلاس ها اضافه می شود تا کارهایی که انجام می دهند را توضیح دهد. در پایتون، رشته docstring از طریق ویژگی __doc__ در دسترس است.

کامنت های docstring میتوانند هر چند خط که نیاز دارید، باشند:

"""
	This is a docstring.
	it can be
	multiple lines.
"""
print('mongard')