هلیو کیددنیای برنامه‌نویسی نوجوانان
پایتون · سطح ۱ · ۱۱ مرحله

مستندسازی کد

Documenting your code

نحوه مستندسازی کد پایتون و ایجاد وب سایت برای پروژه های نرم افزاری را بیاموزید

ترجمهٔ فارسی ماشینی است و ممکن است در اصطلاحات دقیق نباشد. با انتخاب «هر دو» می‌توانی متن اصلی را هم بخوانی.
مرحلهٔ ۱

مقدمه

مقدمه

هنگامی که یک پروژه واقعا مفید ایجاد کرده اید و می خواهید آن را با افراد دیگر به اشتراک بگذارید، یک گام مهم ایجاد اسنادی است که به افراد کمک می کند بفهمند کد چه کار می کند، چگونه کار می کند و چگونه می توانند از آن استفاده کنند.

برای به اشتراک گذاشتن کدی که ایجاد کرده اید و کمک به افراد در استفاده از آن، وب سایتی ایجاد می کنید که پروژه شما را مستند می کند.

آنچه را که خواهید ساخت

این راهنما به شما یاد می دهد که چگونه یک وب سایت برای پروژه خود بسازید که به طور خودکار اسنادی را برای کد پایتون شما ایجاد کند.

وب سایت پروژه

آنچه خواهید آموخت

  • نحوه مستندسازی کدهای پایتون

  • نحوه تولید خودکار اسناد

  • نحوه استفاده از زبان نشانه گذاری reStructuredText

  • نحوه ایجاد یک وب سایت پروژه با استفاده از Sphinx

این پروژه عناصری از رشته های زیر را پوشش می دهد برنامه درسی ساخت دیجیتال رزبری پای:

اطلاعات تکمیلی برای مربیان

اگر نیاز به چاپ این پروژه دارید، لطفا از نسخه مناسب چاپگر.

از پیوند موجود در پاورقی برای دسترسی به مخزن GitHub برای این پروژه استفاده کنید، که شامل تمام منابع (از جمله یک نمونه پروژه تمام شده) در پوشه «en/resources» است.

محیط اجرای پروژه

این پروژه در محیطی که در مراحل آموزش معرفی شده اجرا می‌شود؛ مانند Python دسکتاپ، Thonny، Jupyter یا Raspberry Pi. کدهای مخصوص این ابزارها را در همان محیط اجرا کن.

کارگاه آزاد پایتون هلیو ←
معرفی و پیش‌نمایش پروژه

نحوه مستندسازی کد پایتون و ایجاد وب سایت برای پروژه های نرم افزاری را بیاموزید