دوره آموزشی ساخت برنامههای تایپاسکریپت با 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
سرفصل ها
0. مقدمه
- 01 - تقویت برنامههای TypeScript با JSDoc
- 02 - آنچه باید بدانید
1. ترکیب JSDoc
- 03 - پیکربندی پروژه TypeScript خود
- 04 - نوشتن تابع TypeScript
- 05 - حاشیه نویسی یک تابع TypeScript
- 06 - افزودن اطلاعات اضافی با برچسب ها
- 07 - کلاسهای مستندسازی
- 08 - مستندسازی روشهای کلاس
2. پیکربندی JSDoc
- 09 - ایجاد یک وب سایت با JSDoc
- 10 - انتخاب تم سفارشی
- 11 - فعال کردن پشتیبانی Markdown
- 12 - افزودن لینک بین فایل ها
- 13 - چالش - اضافه کردن مستندات به کلاس
- 14 - راه حل - افزودن مستندات به کلاس
3. کار با انواع پیشرفته
- 15 - مستند سازی انواع ژنریک
- 16 - شامل TypeDoc
- 17 - حفاظ نوع ساختمان با مستندات
- 18 - ایجاد انواع ابزار
4. کار با فایل ها
- 19 - ایجاد اسناد Markdown
- 20 - افزودن یک فایل README سفارشی
- 21 - مستندسازی REST API
- 22 - چالش - افزودن مستندات POST و PUT
- 23 - راه حل - افزودن مستندات POST و PUT
نتیجه گیری
- 24 - مراحل بعدی
دوره های مرتبط
- دوره آموزشی تایپاسکریپت پیشرفته: ژنریکها و انواع شرطی
- دوره آموزشی انتخاب زبان مناسب برای بکاند: TypeScript، Go یا Rust برای پروژههای جدید شما
- دوره آموزشی تکنیکهای پیشرفته React Router با TypeScript
- دوره آموزشی TypeScript برای توسعهدهندگان Node.js
- دوره آموزشی ساخت یک مونو ریپو مقیاسپذیر با استفاده از جاوااسکریپت و تایپاسکریپت
- دوره آموزشی مقیاس بندی TypeScript برای توسعه دهندگان سازمانی
- دوره آموزشی مفاهیم پیشرفته تایپاسکریپت
- دوره آموزشی تایپاسکریپت برای توسعهدهندگان جاوااسکریپت