✳️ توضیحات در پایتون — به زبان ساده
در مطلب «زبان برنامه نویسی پایتون (Python) — از صفر تا صد» که پیش‌تر در مجله فرادرس منتشر شده بود، به چیستی «زبان برنامه‌نویسی پایتون» (Python Programming Language)، دلایل محبوبیت، ویژگی‌ها، مزایا و معایب، کاربردها، بازار کار، نسخه‌های مختلف زبان پایتون (۲ و ۳) و روش انتخاب نسخه مناسب و تفاوت‌های این زبان با دیگر زبان‌های برنامه‌نویسی پرداخته شد. همچنین، در مطلب «پایتون برای مبتدیان — به زبان ساده» مباحث مقدماتی پایتون شامل روش نصب مقدماتی و اجرای آن و همچنین، روش نوشتن برنامه «Hello World!» برای افراد مبتدی مورد بررسی قرار گرفت. در مطلبی با عنوان «کلیدواژه‌ها و شناساگرها در پایتون — به زبان ساده» به موضوع «کلمات رزرو شده» (Reserved Words)، «کلیدواژه‌ها» (Keywords) و «شناساگرها» (Identifier) پرداخته شد. در مطلب «دستورات پایتون و دندانه‌گذاری — به زبان ساده» به مفهوم دستور در پایتون و روش دندانه‌گذاری هنگام نوشتن دستورات پرداخته شد. در این مطلب، به مفهوم توضیحات در پایتون پرداخته می‌شود. برای یادگیری روش نصب پایتون در سیستم‌عامل‌های گوناگون، مطالعه راهنماهای جامع و تصویری زیر توصیه می‌شود.
══ فهرست مطالب ══
○ توضیحات در پایتون
○ «داک‌استرینگ» (Docstring) در پایتون
🔸 توضیحات در پایتون
استفاده از «توضیحات» (Comments) ضمن نوشتن برنامه بسیار حائز اهمیت است. توضیحات همانطور که از نام آن پیداست، توضیحی را پیرامون کد ارائه می‌کند و در واقع نشان می‌دهد که یک دستور چه کار می‌کند و یا درون یک برنامه چه می‌گذرد؛ اما خود توضیحات در پایتون جزوی از کد قابل اجرا محسوب نمی‌شود. با افزودن توضیحات به کد، هنگامی که فردی به کد منبع یک برنامه نگاه می‌کند، بدون نیاز به صرف زمان زیاد برای درک آنچه در آن کد به وقوع پیوسته می‌تواند از ساز و کار آن آگاه شود. کاربر ممکن است جزئیات کلیدی برنامه‌ای را که مدت‌ها پیش نوشته است، فراموش کند. نوشتن توضیحات در برنامه، کمک می‌کند تا فرد هر بار که کد خود را باز می‌کند، به سرعت و سادگی متوجه شود که در بخش‌های مختلف آن چه اتفاقی می‌افتد. بنابراین، تخصیص زمان به نوشتن توضیحات در پایتون (ضمن نوشتن برنامه)، بسیار مفید و ثمربخش خواهد بود.
در پایتون، از علامت «هش» (Hash) یعنی # برای شروع نوشتن یک توضیح استفاده می‌شود. در صورتی که نیاز به نوشتن توضیحات در چند خط پشت سر هم باشد، باید در ابتدای هر خط از علامت # استفاده شود. البته راهکارهای بهتری نیز برای نوشتن توضیحات در چند خط وجود دارد که در ادامه بیان شده‌اند. همانطور که پیش‌تر نیز بیان شد، توضیحات برای برنامه‌نویس‌ها به منظور درک بهتر برنامه است و مفسر پایتون آن‌ها را نادیده می‌گیرد. در واقع، توضیحات بخش اجرایی کد محسوب نمی‌شوند.
اگر توضیحات در پایتون طولانی است و در چند خط ادامه پیدا می‌کند، راهکارهای مختلفی برای نوشتن آن وجود دارد. ساده‌ترین راه همانطور که پیش از این نیز بیان شد، استفاده از علامت هش (#) در آغاز هر خط است. مثال زیر در این راستا قابل توجه است.
#This is a long comment
#and it extends
#to multiple lines
🔸 «داک‌استرینگ» (Docstring) در پایتون
داک‌استرینگ، مخفف «داکیومنتیشن استرینگ» (Documentation String) است. داک‌استرینگ، رشته‌ای است که به عنوان اولین دستور در یک «ماژول» (Module)، «تابع» (Function)، «کلاس» (Class) و یا تعریف «متد» (Method) به قرار می‌گیرد. کاربر باید در داک‌استرینگ بنویسد که یک تابع/کلاس چه کاری انجام می‌دهد. نقل قول سه‌تایی هنگام نوشتن داک‌استرینگ‌ها مورد استفاده قرار می‌گیرد. مثال زیر در این راستا قابل توجه است.
def double(num):
"""Function to double the value"""
return 2*num
داک‌استرینگ به صورت خصیصه doc تابع برای استفاده کاربر موجود است. پس از اجرای کد بالا در شل، برای درک بهتر مطلب می‌توان کد زیر را نیز در شل اجرا کرد.
>>> print(double.doc)
Function to double the value
مطالعه ادامه مطلب 👇👇
🔗 توضیحات در پایتون — به زبان ساده — کلیک کنید (+)
📌 کانال اختصاصی آموزشی برنامه نویسی پایتون
آخرین مطالب علمی، مقالات رایگان و ویدئوهای آموزشی برنامه نویسی پایتون را در کانال اختصاصی [@FaraPython] دنبال کنید. 👇
@FaraPython — مطالب و آموزش‌های برنامه نویسی پایتون فرادرس
در مطلب «زبان برنامه نویسی پایتون (Python) — از صفر تا صد» که پیش‌تر در مجله فرادرس منتشر شده بود، به چیستی «زبان برنامه‌نویسی پایتون» (Python Programming Language)، دلایل محبوبیت، ویژگی‌ها، مزایا و معایب، کاربردها، بازار کار، نسخه‌های مختلف زبان پایتون (۲ و ۳) و روش انتخاب نسخه مناسب و تفاوت‌های این زبان با دیگر زبان‌های برنامه‌نویسی پرداخته شد. همچنین، در مطلب «پایتون برای مبتدیان — به زبان ساده» مباحث مقدماتی پایتون شامل روش نصب مقدماتی و اجرای آن و همچنین، روش نوشتن برنامه «Hello World!» برای افراد مبتدی مورد بررسی قرار گرفت. در مطلبی با عنوان «کلیدواژه‌ها و شناساگرها در پایتون — به زبان ساده» به موضوع «کلمات رزرو شده» (Reserved Words)، «کلیدواژه‌ها» (Keywords) و «شناساگرها» (Identifier) پرداخته شد. در مطلب «دستورات پایتون و دندانه‌گذاری — به زبان ساده» به مفهوم دستور در پایتون و روش دندانه‌گذاری هنگام نوشتن دستورات پرداخته شد. در این مطلب، به مفهوم توضیحات در پایتون پرداخته می‌شود. برای یادگیری روش نصب پایتون در سیستم‌عامل‌های گوناگون، مطالعه راهنماهای جامع و تصویری زیر توصیه می‌شود.
══ فهرست مطالب ══
○ توضیحات در پایتون
○ «داک‌استرینگ» (Docstring) در پایتون
🔸 توضیحات در پایتون
استفاده از «توضیحات» (Comments) ضمن نوشتن برنامه بسیار حائز اهمیت است. توضیحات همانطور که از نام آن پیداست، توضیحی را پیرامون کد ارائه می‌کند و در واقع نشان می‌دهد که یک دستور چه کار می‌کند و یا درون یک برنامه چه می‌گذرد؛ اما خود توضیحات در پایتون جزوی از کد قابل اجرا محسوب نمی‌شود. با افزودن توضیحات به کد، هنگامی که فردی به کد منبع یک برنامه نگاه می‌کند، بدون نیاز به صرف زمان زیاد برای درک آنچه در آن کد به وقوع پیوسته می‌تواند از ساز و کار آن آگاه شود. کاربر ممکن است جزئیات کلیدی برنامه‌ای را که مدت‌ها پیش نوشته است، فراموش کند. نوشتن توضیحات در برنامه، کمک می‌کند تا فرد هر بار که کد خود را باز می‌کند، به سرعت و سادگی متوجه شود که در بخش‌های مختلف آن چه اتفاقی می‌افتد. بنابراین، تخصیص زمان به نوشتن توضیحات در پایتون (ضمن نوشتن برنامه)، بسیار مفید و ثمربخش خواهد بود.
در پایتون، از علامت «هش» (Hash) یعنی # برای شروع نوشتن یک توضیح استفاده می‌شود. در صورتی که نیاز به نوشتن توضیحات در چند خط پشت سر هم باشد، باید در ابتدای هر خط از علامت # استفاده شود. البته راهکارهای بهتری نیز برای نوشتن توضیحات در چند خط وجود دارد که در ادامه بیان شده‌اند. همانطور که پیش‌تر نیز بیان شد، توضیحات برای برنامه‌نویس‌ها به منظور درک بهتر برنامه است و مفسر پایتون آن‌ها را نادیده می‌گیرد. در واقع، توضیحات بخش اجرایی کد محسوب نمی‌شوند.
اگر توضیحات در پایتون طولانی است و در چند خط ادامه پیدا می‌کند، راهکارهای مختلفی برای نوشتن آن وجود دارد. ساده‌ترین راه همانطور که پیش از این نیز بیان شد، استفاده از علامت هش (#) در آغاز هر خط است. مثال زیر در این راستا قابل توجه است.
#This is a long comment
#and it extends
#to multiple lines
🔸 «داک‌استرینگ» (Docstring) در پایتون
داک‌استرینگ، مخفف «داکیومنتیشن استرینگ» (Documentation String) است. داک‌استرینگ، رشته‌ای است که به عنوان اولین دستور در یک «ماژول» (Module)، «تابع» (Function)، «کلاس» (Class) و یا تعریف «متد» (Method) به قرار می‌گیرد. کاربر باید در داک‌استرینگ بنویسد که یک تابع/کلاس چه کاری انجام می‌دهد. نقل قول سه‌تایی هنگام نوشتن داک‌استرینگ‌ها مورد استفاده قرار می‌گیرد. مثال زیر در این راستا قابل توجه است.
def double(num):
"""Function to double the value"""
return 2*num
داک‌استرینگ به صورت خصیصه doc تابع برای استفاده کاربر موجود است. پس از اجرای کد بالا در شل، برای درک بهتر مطلب می‌توان کد زیر را نیز در شل اجرا کرد.
>>> print(double.doc)
Function to double the value
مطالعه ادامه مطلب 👇👇
🔗 توضیحات در پایتون — به زبان ساده — کلیک کنید (+)
📌 کانال اختصاصی آموزشی برنامه نویسی پایتون
آخرین مطالب علمی، مقالات رایگان و ویدئوهای آموزشی برنامه نویسی پایتون را در کانال اختصاصی [@FaraPython] دنبال کنید. 👇
@FaraPython — مطالب و آموزش‌های برنامه نویسی پایتون فرادرس
