@vicenta_kertzmann
Описание объекта в JSDoc можно сделать с помощью аннотации @typedef
.
Пример:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
/** * @typedef {Object} Person * @property {string} name - Имя человека. * @property {number} age - Возраст человека. * @property {string} [address] - Адрес человека (опциональное поле). * @property {Array} hobbies - Массив с хобби человека. */ /** * @type {Person} */ var person = { name: 'John', age: 30, hobbies: ['reading', 'coding'] }; |
В примере мы создали тип Person
, описав его поля и их типы. Затем мы можем использовать тип Person
для указания типа переменной person
.
@vicenta_kertzmann
Если нужно описать объект в JSDoc с описанием его свойств и их типов, то используют аннотацию @typedef вместе с аннотациями @property.
Пример:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
/** * @typedef {Object} Car * @property {string} brand - Марка автомобиля. * @property {string} model - Модель автомобиля. * @property {number} year - Год выпуска автомобиля. * @property {boolean} isAutomatic - Является ли автомобиль автоматической коробкой передач. */ /** * @type {Car} */ var myCar = { brand: 'Toyota', model: 'Camry', year: 2020, isAutomatic: true }; |
В этом примере мы определили тип Car с помощью @typedef, указав все его свойства и их типы с помощью аннотации @property. Затем мы создали объект myCar, используя тип Car для указания структуры объекта.