توضیحات در پایتون – به زبان ساده
- نصب پایتون — از صفر تا صد
- نصب پایتون در ویندوز — از صفر تا صد
- نصب پایتون در لینوکس — از صفر تا صد
- نصب پایتون در مک — از صفر تا صد
توضیحات در پایتون
کاربر ممکن است جزئیات کلیدی برنامه‌ای را که مدت‌ها پیش نوشته است، فراموش کند. نوشتن توضیحات در برنامه، کمک می‌کند تا فرد هر بار که کد خود را باز می‌کند، به سرعت و سادگی متوجه شود که در بخش‌های مختلف آن چه اتفاقی می‌افتد. بنابراین، تخصیص زمان به نوشتن توضیحات در پایتون (ضمن نوشتن برنامه)، بسیار مفید و ثمربخش خواهد بود.
در پایتون، از علامت «هش» (Hash) یعنی # برای شروع نوشتن یک توضیح استفاده می‌شود. در صورتی که نیاز به نوشتن توضیحات در چند خط پشت سر هم باشد، باید در ابتدای هر خط از علامت # استفاده شود. البته راهکارهای بهتری نیز برای نوشتن توضیحات در چند خط وجود دارد که در ادامه بیان شده‌اند. همانطور که پیش‌تر نیز بیان شد، توضیحات برای برنامه‌نویس‌ها به منظور درک بهتر برنامه است و مفسر پایتون آن‌ها را نادیده می‌گیرد. در واقع، توضیحات بخش اجرایی کد محسوب نمی‌شوند.
توضیحات چند خطی
اگر توضیحات در پایتون طولانی است و در چند خط ادامه پیدا می‌کند، راهکارهای مختلفی برای نوشتن آن وجود دارد. ساده‌ترین راه همانطور که پیش از این نیز بیان شد، استفاده از علامت هش (#) در آغاز هر خط است. مثال زیر در این راستا قابل توجه است.
راهکار دیگر، استفاده از سه علامت «نقل قول» (Quotes) انگلیسی به صورت ''' یا """ است. این علامت‌های نقل قول سه تایی به طور کلی برای رشته‌های چند خطی مورد استفاده قرار می‌گیرند. در صورتی که توضیحات «داک‌استرینگ» (Docstrings) نباشد، هیچ کد اضافی ایجاد نخواهند کرد. در ادامه، مفهوم داک‌استرینگ در پایتون تشریح خواهد شد.
«داک‌استرینگ» (Docstring) در پایتون
داک‌استرینگ، مخفف «داکیومنتیشن استرینگ» (Documentation String) است. داک‌استرینگ، رشته‌ای است که به عنوان اولین دستور در یک «ماژول» (Module)، «تابع» (Function)، «کلاس» (Class) و یا تعریف «متد» (Method) به قرار می‌گیرد. کاربر باید در داک‌استرینگ بنویسد که یک تابع/کلاس چه کاری انجام می‌دهد.
نقل قول سه‌تایی هنگام نوشتن داک‌استرینگ‌ها مورد استفاده قرار می‌گیرد. مثال زیر در این راستا قابل توجه است.
داک‌استرینگ به صورت خصیصه __doc__ تابع برای استفاده کاربر موجود است. پس از اجرای کد بالا در شل، برای درک بهتر مطلب می‌توان کد زیر را نیز در شل اجرا کرد.
اگر نوشته بالا برای شما مفید بوده است، آموزش‌های زیر نیز به شما پیشنهاد می‌شوند:
- مجموعه آموزش‌های برنامه‌نویسی پایتون Python
- آموزش تکمیلی برنامه‌نویسی پایتون
- مجموعه آموزش‌های داده‌کاوی و یادگیری ماشین
- زبان برنامه‌نویسی پایتون (Python) — از صفر تا صد
- یادگیری علم داده (Data Science) با پایتون — از صفر تا صد
- آموزش پایتون (Python) — مجموعه مقالات جامع وبلاگ فرادرس
- متد Split در پایتون – توضیح به زبان ساده با مثال و کد
^^
مطالب مجله فرادرس را در جستجوی گوگل سریع‌تر ببینید
آموزش مفید و کوتاهی بود ، خیلی ممنونم 🙂