تبلیغات

دوره H پایتون – فصل 3 (توابع و ماژول‌ها) – درس 2 (کامنت‌ها و داکیومنت‌نویسی)

دوره H پایتون
نوشته شده توسط هادی اکبرزاده

دوره H برنامه نویسی پایتون
فصل سوم: توابع و ماژول‌ها در پایتون
درس دوم: کامنت در پایتون و داکیومنت‌نویسی


قبل از اینکه با کامنت‌نویسی در پایتون آشنا شوید، ابتدا مقاله «مفهوم کامنت در برنامه نویسی چیست؟!» را مطالعه کرده و سپس در ادامه با فول‌کده همراه باشید.

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

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

در پایتون برای اینکه بتوانیم کامنت بنویسیم، آن را با علامت # شروع می‌کنیم. و تمام متنی که بعد از این علامت نوشته شود، کامنت به حساب می‌آید. برای مثال:

نتیجه‌ی این کد:

>>>
1
>>>


پایتون از کامنت‌نویسی چند خطی پشتیبانی نمی‌کند و می‌توانید همانند بالا از # در ابتدای هر خط استفاده کنید تا بتوانید چند خطی بنویسید. همانند زبان برنامه‌نویسی C.

داکیونت‌نویسی

داکیومنت‌نویسی یا مستندسازی (Docstrings یا documentation strings)، همانند کامنت است که برای توضیح کد طراحی شده است که سینتکس خاصی برای خود دارند. در مثال زیر، یک توضیح برای تابع shout نوشته‌ایم و از آن می‌توان فهمید که اگر بخواهیم برای یک تابع توضیحی بنویسیم، بایستی آن را در زیر تابع باید بنویسیم؛ به صورت زیر:

نتیجه‌ی این کد:

>>>
spam!
>>>


برخلاف کامنت‌ها، داکیومنت‌ها در لحظه‌ی ruuntime حفظ شده و پاک نخواهند شد.
درس بعدی (به زودی)درس قبلی
تبلیغات
0
کانال تلگرام فول کده

درباره نویسنده

هادی اکبرزاده

[ مدیر فول کده ]

دانشجوی ارشد شبیه ساز هوشمند و مدیر فول کده

پاسخ دهید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

نظرات ثبت شده بدون دیدگاه