توضیحات پیشنهادی نظرات اشتراک
تبلیغات

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

دوره H پایتون

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


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

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

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

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

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

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

>>>
1
>>>


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

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

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

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

>>>
spam!
>>>


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

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

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

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

علاقه‌مند به اشتراک‌گذاری اطلاعات در هر زمینه‌ای
برنامه‌نویس فول استک

پاسخ دهید

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

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