این ویدیو آموزشی به شما نشان میدهد که چگونه میتوانید از ابزار گیتهاب کوپایلت (GitHub Copilot) برای خودکارسازی فرآیند مستندسازی کد در محیط ویژوال استودیو کد (Visual Studio Code) استفاده کنید. دیگر نیازی نیست که وقت زیادی را صرف نوشتن مستندات کنید، گیت هاب کوپایلت این کار را برای شما انجام میدهد.
قابلیتهای کلیدی که در این ویدیو نمایش داده میشود:
- گفتگوی فضای کاری (Workspace chat):
- توضیح کدهای ناآشنا: اگر با قطعه کدی روبرو شدید که متوجه آن نمیشوید، میتوانید از کوپایلت بخواهید که آن را برای شما توضیح دهد.
- ایجاد فایلهای README: فایل README یک فایل متنی است که اطلاعات کلی در مورد پروژه شما ارائه میدهد. کوپایلت میتواند به شما در ایجاد این فایل کمک کند.
- اصلاح دستورات با استفاده از متغیرهای گفتگو (Chat Variables): میتوانید با استفاده از متغیرها، دستورات خود را دقیقتر و هدفمندتر کنید.
- نمای گفتگوی گیت هاب کوپایلت (GitHub Copilot Chat View):
- استفاده از سوالات پیشنهادی: کوپایلت سوالاتی را بر اساس متن کد شما پیشنهاد میدهد که میتوانید از آنها برای دریافت اطلاعات بیشتر استفاده کنید.
- اقدامات هوشمند (Smart Actions):
- "این را توضیح بده" (Explain This): با انتخاب این گزینه، کوپایلت قطعه کد انتخاب شده را برای شما توضیح میدهد.
- "ایجاد مستندات" (Generate Docs): برای ایجاد کامنتهای درون خطی.
- نمای گفتگوی درون خطی (Inline Chat View):
- ایجاد کامنتهای درون خطی: کوپایلت میتواند کامنتهایی را در داخل کد شما ایجاد کند که عملکرد کد را توضیح میدهند.
- استفاده از دستور "doc/": این دستور نیز برای ایجاد کامنتهای درون خطی استفاده میشود.
- پیامهای ثبت تغییرات (Commit Messages):
- ایجاد خلاصه ثبت تغییرات: وقتی تغییراتی در کد خود ایجاد میکنید، باید یک پیام ثبت تغییرات بنویسید که توضیح دهد چه تغییراتی ایجاد کردهاید. کوپایلت میتواند به شما در نوشتن این پیام کمک کند.