JSDoc частые шаблоны
Ранее я писал сообщение на тему Зачем нужен JSDoc. На этот раз я углублюсь в детали и расскажу о нескольких из наиболее частых шаблонов, которые я использую.
Базовый объект
Используйте@typedef
@type
для описания объекта. Вы также можете оставлять необязательные комментарии.
Ограниченный набор ценностей
Смешайте набор значений, чтобы создать новый тип.
Функция
Используйте @param
@return
, чтобы добавить описание к функциям.
Обещания
Используйте Promise<...>
для выполнения обещаний.
Логическая логика с типами
Иногда полезно смешивать свой шрифт. Например, если вам нужен базовый тип и несколько расширений.
Импорт типов
Используйте @import
, чтобы получить @typedef
из другого файла
С 3-х сторонними типами
Импортируйте типы из сторонних библиотек. Типы доступны, если библиотека использует сам typescript или JSDoc (почти всегда).
Тип модуля
Весь модуль можно использовать как тип, импортировав его в @type {...}
. Работает как с common-js-modules, так и с es6-modules.
Поддержка VSCode
Код Visual Studio - легкий, простой, но сложный современный редактор. По умолчанию он имеет отличную поддержку JSDoc. Он проверяет ваш код с точки зрения определенных типов, анализирует и помогает вам работать более продуктивно.
Мои другие статьи JSDoc:
- Зачем нужен JSDoc
- JSDoc & React
- «JSDoc & Generic типы. Машинопись"
- Хватит JSDoc, хватит
- JSDoc in React, Экспресс-приложение