توضیحات در پایتون — به زبان ساده

در مطلب «زبان برنامه نویسی پایتون (Python) — از صفر تا صد» که پیش‌تر در مجله فرادرس منتشر شده بود، به چیستی «زبان برنامه‌نویسی پایتون» (Python Programming Language)، دلایل محبوبیت، ویژگی‌ها، مزایا و معایب، کاربردها، بازار کار، نسخه‌های مختلف زبان پایتون (۲ و ۳) و روش انتخاب نسخه مناسب و تفاوت‌های این زبان با دیگر زبان‌های برنامه‌نویسی پرداخته شد. همچنین، در مطلب «پایتون برای مبتدیان — به زبان ساده» مباحث مقدماتی پایتون شامل روش نصب مقدماتی و اجرای آن و همچنین، روش نوشتن برنامه «Hello World!‎» برای افراد مبتدی مورد بررسی قرار گرفت. در مطلبی با عنوان «کلیدواژه‌ها و شناساگرها در پایتون — به زبان ساده» به موضوع «کلمات رزرو شده» (Reserved Words)، «کلیدواژه‌ها» (Keywords) و «شناساگرها» (Identifier) پرداخته شد. در مطلب «دستورات پایتون و دندانه‌گذاری — به زبان ساده» به مفهوم دستور در پایتون و روش دندانه‌گذاری هنگام نوشتن دستورات پرداخته شد. در این مطلب، به مفهوم توضیحات در پایتون پرداخته می‌شود. برای یادگیری روش نصب پایتون در سیستم‌عامل‌های گوناگون، مطالعه راهنماهای جامع و تصویری زیر توصیه می‌شود.

• نصب پایتون — از صفر تا صد
• نصب پایتون در ویندوز — از صفر تا صد
• نصب پایتون در لینوکس — از صفر تا صد
• نصب پایتون در مک — از صفر تا صد

توضیحات در پایتون

استفاده از «توضیحات» (Comments) ضمن نوشتن برنامه بسیار حائز اهمیت است. توضیحات همانطور که از نام آن پیداست، توضیحی را پیرامون کد ارائه می‌کند و در واقع نشان می‌دهد که یک دستور چه کار می‌کند و یا درون یک برنامه چه می‌گذرد؛ اما خود توضیحات در پایتون جزوی از کد قابل اجرا محسوب نمی‌شود. با افزودن توضیحات به کد، هنگامی که فردی به کد منبع یک برنامه نگاه می‌کند، بدون نیاز به صرف زمان زیاد برای درک آنچه در آن کد به وقوع پیوسته می‌تواند از ساز و کار آن آگاه شود.

فیلم آموزش برنامه نویسی پایتون Python – مقدماتی در فرادرس

کلیک کنید

کاربر ممکن است جزئیات کلیدی برنامه‌ای را که مدت‌ها پیش نوشته است، فراموش کند. نوشتن توضیحات در برنامه، کمک می‌کند تا فرد هر بار که کد خود را باز می‌کند، به سرعت و سادگی متوجه شود که در بخش‌های مختلف آن چه اتفاقی می‌افتد. بنابراین، تخصیص زمان به نوشتن توضیحات در پایتون (ضمن نوشتن برنامه)، بسیار مفید و ثمربخش خواهد بود.

در پایتون، از علامت «هش» (Hash) یعنی # برای شروع نوشتن یک توضیح استفاده می‌شود. در صورتی که نیاز به نوشتن توضیحات در چند خط پشت سر هم باشد، باید در ابتدای هر خط از علامت # استفاده شود. البته راهکارهای بهتری نیز برای نوشتن توضیحات در چند خط وجود دارد که در ادامه بیان شده‌اند. همانطور که پیش‌تر نیز بیان شد، توضیحات برای برنامه‌نویس‌ها به منظور درک بهتر برنامه است و مفسر پایتون آن‌ها را نادیده می‌گیرد. در واقع، توضیحات بخش اجرایی کد محسوب نمی‌شوند.

1#This is a comment
2#print out Hello
3print('Hello')

توضیحات چند خطی

اگر توضیحات در پایتون طولانی است و در چند خط ادامه پیدا می‌کند، راهکارهای مختلفی برای نوشتن آن وجود دارد. ساده‌ترین راه همانطور که پیش از این نیز بیان شد، استفاده از علامت هش (#) در آغاز هر خط است. مثال زیر در این راستا قابل توجه است.

1#This is a long comment
2#and it extends
3#to multiple lines

راهکار دیگر، استفاده از سه علامت «نقل قول» (Quotes) انگلیسی به صورت ''' یا """ است. این علامت‌های نقل قول سه تایی به طور کلی برای رشته‌های چند خطی مورد استفاده قرار می‌گیرند. در صورتی که توضیحات «داک‌استرینگ» (Docstrings) نباشد، هیچ کد اضافی ایجاد نخواهند کرد. در ادامه، مفهوم داک‌استرینگ در پایتون تشریح خواهد شد.

1"""This is also a
2perfect example of
3multi-line comments"""

«داک‌استرینگ» (Docstring) در پایتون

داک‌استرینگ، مخفف «داکیومنتیشن استرینگ» (Documentation String) است. داک‌استرینگ، رشته‌ای است که به عنوان اولین دستور در یک «ماژول» (Module)، «تابع» (Function)، «کلاس» (Class) و یا تعریف «متد» (Method) به قرار می‌گیرد. کاربر باید در داک‌استرینگ بنویسد که یک تابع/کلاس چه کاری انجام می‌دهد.

فیلم آموزش برنامه نویسی پایتون + مثال های عملی در Python در فرادرس

کلیک کنید

نقل قول سه‌تایی هنگام نوشتن داک‌استرینگ‌ها مورد استفاده قرار می‌گیرد. مثال زیر در این راستا قابل توجه است.

1def double(num):
2    """Function to double the value"""
3    return 2*num

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

1>>> print(double.__doc__)
2Function to double the value

اگر نوشته بالا برای شما مفید بوده است، آموزش‌های زیر نیز به شما پیشنهاد می‌شوند:

• مجموعه آموزش‌های برنامه‌نویسی پایتون Python
• آموزش تکمیلی برنامه‌نویسی پایتون
• مجموعه آموزش‌های داده‌کاوی و یادگیری ماشین
• زبان برنامه‌نویسی پایتون (Python) — از صفر تا صد
• یادگیری علم داده (Data Science) با پایتون — از صفر تا صد
• آموزش پایتون (Python) — مجموعه مقالات جامع وبلاگ فرادرس

^^