دوره آموزشی ساخت برنامههای تایپاسکریپت با JSDoc
1 ساعت 9 دقیقهپیشرفته2025-01-08
مدرسین

Eve Porcello
Software Developer and Instructor
جزئیات دوره
مستندسازی باکیفیت، پایهای حیاتی برای همکاری مؤثر در یک تیم توسعهدهنده است. بدون آن، بهراحتی سوءتفاهم و سردرگمی بهویژه در پروژههای پیچیدهی TypeScript به وجود میآید. این دوره طراحی شده است تا مهارتها و دانش مورد نیاز برای مستندسازی کد TypeScript با استفاده از ابزار قدرتمند JSDoc را به شما بیاموزد و شفافیت و ارتباطات کدنویسی شما را ارتقا دهد.
مدرس دوره، "ایو پورچلو"، با مبانی JSDoc شروع میکند و نحو و استفاده از آن را آموزش میدهد. شما خواهید آموخت که چگونه کد TypeScript خود را با اطلاعات دقیق نوع (type) حاشیهنویسی کنید، به گونهای که توابع، کلاسها، و ماژولها برای همه اعضای تیم به وضوح قابل درک باشند. این دوره فراتر از مبانی پیش میرود و به بهترین شیوهها برای ساختاردهی مستندات و تکنیکهای پیشرفته برای تولید مستندات حرفهای API میپردازد.
در پایان دوره، شما توانایی حاشیهنویسی کد خود با اطمینان، ایجاد مستندات جامع برای APIها و مشارکت در همکاری روانتر و موفقیت پروژه را خواهید داشت. چه تازهکار باشید و چه به دنبال ارتقای مهارتهای خود در مستندسازی، این دوره به شما کمک میکند تا سطح مستندسازی خود را به مرحلهای بالاتر برسانید.
اهداف آموزشی:
تسلط بر استفاده از حاشیهنویسی JSDoc برای مستندسازی مؤثر کد TypeScript.
تولید مستندات حرفهای API با استفاده از قابلیتهای پیشرفته JSDoc.
حاشیهنویسی توابع، کلاسها و ماژولها با اطمینان برای بهبود همکاری تیم توسعه.
درک بهترین شیوهها برای ایجاد مستندات واضح، ساختاریافته و مؤثر.
مدرس دوره، "ایو پورچلو"، با مبانی JSDoc شروع میکند و نحو و استفاده از آن را آموزش میدهد. شما خواهید آموخت که چگونه کد TypeScript خود را با اطلاعات دقیق نوع (type) حاشیهنویسی کنید، به گونهای که توابع، کلاسها، و ماژولها برای همه اعضای تیم به وضوح قابل درک باشند. این دوره فراتر از مبانی پیش میرود و به بهترین شیوهها برای ساختاردهی مستندات و تکنیکهای پیشرفته برای تولید مستندات حرفهای API میپردازد.
در پایان دوره، شما توانایی حاشیهنویسی کد خود با اطمینان، ایجاد مستندات جامع برای APIها و مشارکت در همکاری روانتر و موفقیت پروژه را خواهید داشت. چه تازهکار باشید و چه به دنبال ارتقای مهارتهای خود در مستندسازی، این دوره به شما کمک میکند تا سطح مستندسازی خود را به مرحلهای بالاتر برسانید.
اهداف آموزشی:
تسلط بر استفاده از حاشیهنویسی JSDoc برای مستندسازی مؤثر کد TypeScript.
تولید مستندات حرفهای API با استفاده از قابلیتهای پیشرفته JSDoc.
حاشیهنویسی توابع، کلاسها و ماژولها با اطمینان برای بهبود همکاری تیم توسعه.
درک بهترین شیوهها برای ایجاد مستندات واضح، ساختاریافته و مؤثر.
مهارت ها
TypeScriptEcma InternationalJavaScriptWeb Development ToolsFront-End Web DevelopmentWeb DevelopmentProgramming LanguagesOpen SourceSoftware DevelopmentOne-Off
سرفصل ها
مقدمه
- تقویت برنامههای TypeScript با JSDoc
- آنچه باید بدانید
ترکیب JSDoc
- پیکربندی پروژه TypeScript خود
- نوشتن تابع TypeScript
- حاشیه نویسی یک تابع TypeScript
- افزودن اطلاعات اضافی با برچسب ها
- کلاسهای مستندسازی
- مستندسازی روشهای کلاس
پیکربندی JSDoc
- ایجاد یک وب سایت با JSDoc
- انتخاب تم سفارشی
- فعال کردن پشتیبانی Markdown
- افزودن لینک بین فایل ها
- چالش - اضافه کردن مستندات به کلاس
- راه حل - افزودن مستندات به کلاس
کار با انواع پیشرفته
- مستند سازی انواع ژنریک
- شامل TypeDoc
- حفاظ نوع ساختمان با مستندات
- ایجاد انواع ابزار
کار با فایل ها
- ایجاد اسناد Markdown
- افزودن یک فایل README سفارشی
- مستندسازی REST API
- چالش - افزودن مستندات POST و PUT
- راه حل - افزودن مستندات POST و PUT
نتیجه گیری
- مراحل بعدی