آموزش ساخت برنامه های TypeScript با JSDoc

مقدمه Introduction

• تقویت برنامه های TypeScript با JSDoc Enhancing TypeScript applications with JSDoc

• آنچه شما باید بدانید What you should know

1. ترکیب JSDoc 1. Incorporating JSDoc

• حاشیه نویسی یک تابع TypeScript Annotating a TypeScript function

• نوشتن تابع TypeScript Writing a TypeScript function

• مستندسازی روش های کلاس Documenting class methods

• پیکربندی پروژه TypeScript شما Configuring your TypeScript project

• اضافه کردن اطلاعات اضافی با برچسب ها Adding additional information with tags

• مستندسازی کلاس ها Documenting classes

2. پیکربندی JSDoc 2. JSDoc Configuration

• افزودن لینک بین فایل ها Adding links between files

• چالش: اضافه کردن اسناد به کلاس Challenge: Adding documentation to a class

• انتخاب یک تم سفارشی Selecting a custom theme

• راه حل: افزودن مستندات به کلاس Solution: Adding documentation to a class

• فعال کردن پشتیبانی Markdown Enabling Markdown support

• ایجاد وب سایت با JSDoc Generating a website with JSDoc

3. کار با انواع پیشرفته 3. Working with Advanced Types

• مستندسازی انواع عمومی Documenting generic types

• دارای TypeDoc است Incorporating TypeDoc

• ایجاد انواع ابزار Creating utility types

• حفاظ نوع ساختمان با مستندات Building type guards with documentation

4. کار با فایل ها 4. Working with Files

• راه حل: اضافه کردن اسناد POST و PUT Solution: Adding POST and PUT documentation

• ایجاد اسناد Markdown Generating Markdown docs

• چالش: اضافه کردن اسناد POST و PUT Challenge: Adding POST and PUT documentation

• افزودن یک فایل README سفارشی Adding a custom README file

• مستندسازی یک REST API Documenting a REST API

نتیجه گیری Conclusion

• مراحل بعدی Next steps