وقتی نوبت به نوشتن کد جاوا اسکریپت واضح و قابل فهم می رسد، نظرات JSDoc یک ابزار ضروری است. مستندسازی صحیح کد شما نه تنها درک آنچه نوشته‌اید را برای دیگر توسعه‌دهندگان آسان‌تر می‌کند، بلکه به جلوگیری از اشکالات آینده و دسترسی بیشتر به نگهداری کد کمک می‌کند. یکی از مهمترین جنبه های نوشتن نظرات JSDoc این است که انواع خود را به درستی تعریف کنید. در این مقاله، ما مزایا و بهترین روش‌های استفاده از تعاریف نوع را به‌جای تعریف بررسی خواهیم کرد {Object} هنگام تعریف اشیاء در نظرات JSDoc تایپ کنید.
را {Object} type یک نوع عمومی است که می تواند برای توصیف هر شی در جاوا اسکریپت استفاده شود. با این حال، در حالی که ممکن است استفاده از آن راحت به نظر برسد {Object} برای تعریف انواع شی در نظرات JSDoc، این عمل می تواند منجر به سردرگمی و ابهام شود. فقط با مشخص کردن {Object}، اطلاعات کافی برای سایر توسعه دهندگان برای درک شکل شیء ارائه نمی کنید. همچنین شایان ذکر است که با استفاده از {Object} type به IDE شما امکان نمی دهد تا تکمیل کد را برای ویژگی های شی ارائه دهد، که می تواند بر بهره وری نیز تأثیر بگذارد.
به جای تکیه بر {Object} نوع، ضروری است که انواعی را برای اشیاء خود تعریف کنید که به صراحت ویژگی ها و انواع آنها را توصیف کند. به عنوان مثال، به جای تعریف یک شی با ساده {Object}، می توانید آن را اینگونه تعریف کنید:
/**
* @typedef {Object} User
* @property {string} firstName - The user's first name.
* @property {string} lastName - The user's last name.
* @property {number} age - The user's age.
* @property {string} email - The user's email address.
*/
با تعریف یک نوع، زمینه اضافی را ارائه می کنید که می تواند به توسعه دهندگان دیگر کمک کند تا نحوه تعامل با کد شما را واضح تر درک کنند. در این مثال، یک نوع به نام تعریف کرده ایم User که دارای چهار خاصیت با انواع صریح است.
یکی دیگر از مزایای تعریف صریح انواع این است که می توانید از آنها در قسمت های دیگر کد خود استفاده مجدد کنید. به عنوان مثال، تصور کنید که روی پروژه ای کار می کنید که از اشیاء زیادی با ویژگی های مشابه استفاده می کند. به جای تعریف هر یک از آنها به طور جداگانه، می توانید یک نوع واحد را تعریف کنید و از آن در کل پایگاه کد خود استفاده مجدد کنید.
استفاده از تعاریف نوع در این روش نیز می تواند به تشخیص زودتر خطاها کمک کند. اگر به طور تصادفی سعی کنید از خاصیتی استفاده کنید که در یک نوع تعریف نشده است، IDE شما آن اشتباه را به شما هشدار می دهد و می توانید قبل از اجرای کد آن را اصلاح کنید.
IDE تکمیل خودکار
برای مثال، اگر طرحواره ای را تعریف نکنیم و فقط بگوییم که متغیر فقط an است {Object}، IDE ما نمی داند این شی شامل چه چیزی است، بنابراین نمی تواند تکمیل خودکار را فعال کند، مانند موارد زیر:
اما در عوض اگر از یک تعریف نوع استفاده کنید، IDE متوجه می‌شود که Object شما شامل چه چیزی است و چگونه به آن واکنش نشان می‌دهد، مشابه آنچه که انتظار دارید مثلاً با TypeScript ببینید، همانطور که در اینجا می‌بینید:
نتیجه گیری
در نتیجه، در حالی که ممکن است استفاده از آن راحت به نظر برسد {Object} در نظرات JSDoc تایپ کنید، ارزش آن را دارد که برای تعریف انواع خاص خود وقت بگذارید. با استفاده از تعاریف نوع، می‌توانید زمینه بیشتری را برای توسعه‌دهندگان دیگر فراهم کنید، خوانایی کد را بهبود ببخشید و خطاها را زودتر در فرآیند توسعه تشخیص دهید.
